From fa8a2a4ef4397f64601a4159e94ba74d24ced3f4 Mon Sep 17 00:00:00 2001 From: Grace Goheen <53586774+graciegoheen@users.noreply.github.com> Date: Wed, 6 Sep 2023 12:52:43 -0600 Subject: [PATCH 1/2] Update examples.md --- docs/examples.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index ecb099f..6752ebe 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,6 +1,6 @@ # Examples -For consistency and clarity of the following examples, we're going to use a simplified dbt project. In practice, the model governance features describe are _most_ beneficial for large dbt projects that are struggling to scale. +For consistency and clarity of the following examples, we're going to use a simplified dbt project. In practice, the dbt mesh features describe are _most_ beneficial for large dbt projects that are struggling to scale. We will give a basic example for each command, but to see the full list of additional flags you can add to a given command, check out the [commands page](commands.md). @@ -163,4 +163,4 @@ This will make the upstream project a dependency for the downstream project, con - replace any dependencies in the downstream project on the upstream's models with a cross-project `ref` ![customers and stores sources replaced with cross-project ref](https://github.com/dave-connors-3/mega-corp-big-co-inc/assets/53586774/24d72b99-fbf1-489d-bda8-ccaea267981b) - remove unnecessary sources -![unnecessary sources have been deleted](https://github.com/dave-connors-3/mega-corp-big-co-inc/assets/53586774/fe657aa5-f14e-461e-bacd-30ce55451cb6) \ No newline at end of file +![unnecessary sources have been deleted](https://github.com/dave-connors-3/mega-corp-big-co-inc/assets/53586774/fe657aa5-f14e-461e-bacd-30ce55451cb6) From 6afa15d5ba578f3408575c40386ad3a9fb68c57f Mon Sep 17 00:00:00 2001 From: Grace Goheen Date: Tue, 19 Sep 2023 17:27:12 -0600 Subject: [PATCH 2/2] update docs with "model governance and cross-project lineage" --- README.md | 4 ++-- docs/examples.md | 2 +- docs/index.md | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0a22372..e552443 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ maintained with :heart: by dbt practitioners for dbt practitioners ## Overview -`dbt-meshify` is a CLI tool that automates the creation of dbt mesh features introduced in dbt-core v1.5 and v1.6. This package will leverage your dbt project metadata to create and/or edit the files in your project to properly configure the models in your project with these features. +`dbt-meshify` is a CLI tool that automates the creation of model governance and cross-project lineage features introduced in dbt-core v1.5 and v1.6. This package will leverage your dbt project metadata to create and/or edit the files in your project to properly configure the models in your project with these features. -These dbt mesh features include: +These features include: 1. __[Groups](https://docs.getdbt.com/docs/build/groups)__ - group your models into logical sets. 2. __[Contracts](https://docs.getdbt.com/docs/collaborate/govern/model-contracts)__ - add model contracts to your models to ensure consistent data shape. diff --git a/docs/examples.md b/docs/examples.md index 6752ebe..f51c600 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,6 +1,6 @@ # Examples -For consistency and clarity of the following examples, we're going to use a simplified dbt project. In practice, the dbt mesh features describe are _most_ beneficial for large dbt projects that are struggling to scale. +For consistency and clarity of the following examples, we're going to use a simplified dbt project. In practice, the model governance and cross-project lineage features describe are _most_ beneficial for large dbt projects that are struggling to scale. We will give a basic example for each command, but to see the full list of additional flags you can add to a given command, check out the [commands page](commands.md). diff --git a/docs/index.md b/docs/index.md index cc35a02..7ce4185 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,8 @@ # dbt_meshify -`dbt-meshify` is a CLI tool that automates the creation of dbt mesh features introduced in dbt-core v1.5 and v1.6. This package will leverage your dbt project metadata to create and/or edit the files in your project to properly configure the models in your project with these features. +`dbt-meshify` is a CLI tool that automates the creation of model governance and cross-project lineage features introduced in dbt-core v1.5 and v1.6. This package will leverage your dbt project metadata to create and/or edit the files in your project to properly configure the models in your project with these features. -These dbt mesh features include: +These features include: 1. __[Groups](https://docs.getdbt.com/docs/build/groups)__ - group your models into logical sets. 2. __[Contracts](https://docs.getdbt.com/docs/collaborate/govern/model-contracts)__ - add model contracts to your models to ensure consistent data shape. @@ -14,7 +14,7 @@ This package leverages the dbt-core Python API to allow users to use standard db ## Getting Started -This package helps automate the code development required for adding the dbt mesh features mentioned above. +This package helps automate the code development required for adding the model governance and cross-project lineage features mentioned above. The first question to ask yourself is "which of these features do I want to add to my project"? Do you want to add contracts, create a new group, split your monolithic dbt project in two? Your answer to this question will establish which `dbt-meshify` command is right for you! @@ -40,7 +40,7 @@ The next question to ask yourself is "which of my models do I want to add these Once you've decided: -1. which dbt mesh feature(s) you want to add to your dbt project +1. which feature(s) you want to add to your dbt project 2. which subset of models you want to add those feature(s) to you're ready to use `dbt-meshify`!