Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate documentation based on upstream documented columns #266

Open
AlexFrid opened this issue Nov 22, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested triaged: yes Has been approved for future implementation

Comments

@AlexFrid
Copy link

Is your feature request related to a problem? Please describe.

dbt-coves seems to do a lot to help users adopt analytics engineering best practices.

One of the best practices is documentation.

A problem I (and a lot of people) have is that you have to repeat the column descriptions in every downstream model.

This results in either a bunch of time copying and pasting or downstream models not having proper descriptions.

Describe the solution you'd like
What I would like to do is just do column descriptions once at the base model and then have that propagate through the DAG to all downstream models.

Describe alternatives you've considered
Use PyYAML to make my own solution (more of a learning project since this is not my speciality)

dbt-osmosis has a way to "Automatically generate documentation based on upstream documented columns"

dbt-osmosis yaml document --project-dir ... --profiles-dir ...

@github-actions github-actions bot added documentation Improvements or additions to documentation question Further information is requested triaged: no Hasn't been approved for future implementation labels Nov 22, 2022
@jaredx435k2d0
Copy link

Absolutely love this idea. It'd be a very useful feature, given that your alternative is to write non-DRY code and try to maintain the same documentation in n places.

@BAntonellini BAntonellini added triaged: yes Has been approved for future implementation and removed triaged: no Hasn't been approved for future implementation labels Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested triaged: yes Has been approved for future implementation
Projects
None yet
Development

No branches or pull requests

3 participants