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

[CT-3264] [Feature] Persist docs from data platform to dbt #8905

Closed
3 tasks done
bethanyhipple-dbtlabs opened this issue Oct 25, 2023 · 1 comment
Closed
3 tasks done
Labels
enhancement New feature or request

Comments

@bethanyhipple-dbtlabs
Copy link

bethanyhipple-dbtlabs commented Oct 25, 2023

Is this your first time submitting a feature request?

  • I have read the expectations for open source contributors
  • I have searched the existing issues, and I could not find an existing issue for this feature
  • I am requesting a straightforward extension of existing dbt functionality, rather than a Big Idea better suited to a discussion

Describe the feature

Currently we are able to persist documentation from dbt to the data platform with the persist docs config. However, if the source tables are already documented in the data platform, it would be great to have that documentation show up either in dbt yml (maybe through the generate_source macro in the code_gen package) or just show up in the doc site/explorer.

Who will this benefit?

Both dbt developers and stakeholders will benefit. Developers don't have to copy paste docs and stakeholders can have the documentation they need in the dbt docs.

Are you interested in contributing this feature?

no

@bethanyhipple-dbtlabs bethanyhipple-dbtlabs added enhancement New feature or request triage labels Oct 25, 2023
@github-actions github-actions bot changed the title [Feature] Persist docs from data platform to dbt [CT-3264] [Feature] Persist docs from data platform to dbt Oct 25, 2023
@jtcohen6
Copy link
Contributor

just show up in the doc site/explorer

This is what I would expect — and I think it should already be possible!

Our catalog queries already ask for table/column comments (e.g. here & here in dbt-snowflake), and stick them in catalog.json, so it's just a matter of displaying them when a user-defined description isn't available.

It looks like this has already been tracked over in dbt-docs (although the issue + PR went stale):

Let's follow up with the team building Explorer :)

In the meantime, I'm going to close this one - I don't think there's a dbt-core change we need to make.

@jtcohen6 jtcohen6 closed this as not planned Won't fix, can't repro, duplicate, stale Oct 25, 2023
@jtcohen6 jtcohen6 removed the triage label Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants