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-2810] [CT-2775] [Feature] Show contracts in project's dbt docs site #433

Closed
3 tasks done
Tracked by #7979
sambloom92 opened this issue Jun 30, 2023 · 1 comment · Fixed by #441
Closed
3 tasks done
Tracked by #7979

[CT-2810] [CT-2775] [Feature] Show contracts in project's dbt docs site #433

sambloom92 opened this issue Jun 30, 2023 · 1 comment · Fixed by #441
Assignees
Labels
enhancement New feature or request multi-project

Comments

@sambloom92
Copy link

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

With the recent introduction of model contracts, I've noticed that the dbt docs website produced by dbt docs generate does not seem to include any information on contracts at all (unless I'm not looking in the right place?). A lot of the constraints that previously would have been implemented as tests would have been visible in the project docs website, but if they are implemented as contracts they are not visible anymore, so this could arguably be considered a regression.

Describe alternatives you've considered

Users can always refer to the project's source code for contract information, but I don't see any reason why this information wouldn't be included in the project's docs website

Who will this benefit?

Anyone using contracts in their projects, who want their model contracts to be well documented.

Are you interested in contributing this feature?

No

Anything else?

No response

@sambloom92 sambloom92 added enhancement New feature or request triage labels Jun 30, 2023
@github-actions github-actions bot changed the title [Feature] Show contracts in project's dbt docs site [CT-2775] [Feature] Show contracts in project's dbt docs site Jun 30, 2023
@jtcohen6 jtcohen6 self-assigned this Jul 4, 2023
@jtcohen6
Copy link
Contributor

@sambloom92 Thanks for opening — it's a totally fair & legitimate request.

Let's see if we can make some small tweaks to the dbt-docs site to accommodate model contracts:

  • Lower lift: For a model with an enforced contract, say as much somewhere on that model's page
  • Slightly bigger lift: Represent constraints (U, PK, FK, C) on columns, similar to how they're currently represented for generic tests

I'm going to transfer this one over to the dbt-docs repo, since that's where the code changes will need to happen

@jtcohen6 jtcohen6 removed the triage label Jul 10, 2023
@jtcohen6 jtcohen6 removed their assignment Jul 10, 2023
@jtcohen6 jtcohen6 transferred this issue from dbt-labs/dbt-core Jul 10, 2023
@github-actions github-actions bot changed the title [CT-2775] [Feature] Show contracts in project's dbt docs site [CT-2810] [CT-2775] [Feature] Show contracts in project's dbt docs site Jul 10, 2023
@emmyoop emmyoop mentioned this issue Aug 4, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request multi-project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants