dbt-labs / dbt-technical-blog-writing

Conversation around dbt technical tutorials, blogs, guides, etc
28 stars 1 forks source link

Long term fix for an "under-documented" and "under-tested" dbt project #80

Closed b-per closed 2 years ago

b-per commented 2 years ago

Some projects don't start with good practices on which models/columns should be documented and tested. After a while it can become a huge effort to fix it and the bad state may re-appear

In my mind the fix needs to happen in 2 parts:

  1. find the current models that should be documented/with tests.
    • Decide what needs to be documented/tested (opinionated)
    • Document/test the models that are lacking such information. This can be done manually in YAML (potentially time consuming and error prone) or using the tool Tangata created by Chris Jenkins
  2. Setup automated tests to prevent the rules to be broken, for example leveraging pre-commit hooks

Prior art:

Link to notes / outline / draft: Internal to dbt Labs

Estimated first draft date: 02/10/2022

Any open questions / requests for help from the group?

jasnonaz commented 2 years ago

Fantastic post idea @b-per - looking forward to reading!

b-per commented 2 years ago

I updated the issue with a link to the draft for the article.

gwenwindflower commented 2 years ago

closing this and moving to the docs repo where we are centralizing this work -- we can pick up the convo there -- looks great from a quick scan @b-per excited! https://github.com/dbt-labs/docs.getdbt.com/discussions/1138