We're currently missing documentation, both for users and developers, on:
- data models available to users.
- data source descriptions.
We also need a way to search for data when users don't know exactly what model they need. dbt provides a dbt docs command that takes information provided in the model descriptions along with model-graph relationships to provide a browser-based site to explore the available data.
An example of the current version, at the time of writing, using dbt 1.11:
The documentation build also generates all of the required detail for the pages into a JSON file so we could also write our own tool to parse and display the content.
There seems to be a significant overhaul in dbt v2 so it may be worth waiting until that can be used. We also need to consider how this would fit in with the wider documentation for the project, e.g. #41
We're currently missing documentation, both for users and developers, on:
We also need a way to search for data when users don't know exactly what model they need.
dbtprovides adbt docscommand that takes information provided in the model descriptions along with model-graph relationships to provide a browser-based site to explore the available data.An example of the current version, at the time of writing, using dbt 1.11:
The documentation build also generates all of the required detail for the pages into a JSON file so we could also write our own tool to parse and display the content.
There seems to be a significant overhaul in dbt v2 so it may be worth waiting until that can be used. We also need to consider how this would fit in with the wider documentation for the project, e.g. #41