Flesh out docs on how to develop our data catalog #117
Conversation
jeancochrane
force-pushed
the
jeancochrane/67-data-catalog-flesh-out-dev-docs-on-how-to-build-and-test-with-dbt
branch
from
232d883
to
c0cd6a8
Compare
| ## Model attributes | ||
|
|
||
| * **Name**: _(What should the model be called? See [Model | ||
| naming](/ccao-data/data-architecture#model-naming) for guidance.)_ |
There was a problem hiding this comment.
I went with an absolute link here instead of a relative link because it seemed like a safer choice to link to the project homepage rather than assume a specific file structure going forward. But I could be convinced to switch to a relative link like:
| naming](/ccao-data/data-architecture#model-naming) for guidance.)_ | |
| naming](../../README.md#model-naming) for guidance.)_ |
| * [📝 Design doc for our decision to develop our catalog with | ||
| dbt](../documentation/design-docs/data-catalog.md) | ||
|
|
||
| <h2 id="background-what-does-the-data-catalog-do">🖼️ Background: What does the data catalog do?</h2> |
There was a problem hiding this comment.
The HTML <h2> tag is necessary here because otherwise the emoji in the header text messes up GitHub's autogenerated section permalink.
There was a problem hiding this comment.
@jeancochrane Awesome work! This is a hugely helpful doc and will be quite a boon to me when I start building out more tests and docs. See my minor notes, then good to merge 🚀
dbt/README.md
Outdated
| Ideally, new models should also include descriptions for each column, | ||
| implemented directly in the `schema.yml` model definition. However, our | ||
| column descriptions are currently sparse, so it is not a strict requirement just | ||
| yet. |
There was a problem hiding this comment.
suggestion: I think we should just make it a requirement for new models, since this will be changed in the near future.
There was a problem hiding this comment.
Good call, I tweaked the wording in 7426ff0!
Co-authored-by: Dan Snow <31494343+dfsnow@users.noreply.github.com>
jeancochrane
deleted the
jeancochrane/67-data-catalog-flesh-out-dev-docs-on-how-to-build-and-test-with-dbt
branch
This PR updates
dbt/README.mdto add more detailed docs on how to develop our dbt catalog. These docs represent my best attempt at a full set of information that other developers in this office will need to effectively contribute to the data catalog.As part of these docs, this PR also adds a new
Add a new dbt modelissue template that provides detailed instructions for how to add a new model, assuming no context on how our dbt setup works.Closes #67 and #108.