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

dbt-constraints-docs #2601

Merged
merged 28 commits into from
Feb 19, 2023
Merged

dbt-constraints-docs #2601

merged 28 commits into from
Feb 19, 2023

Conversation

sungchun12
Copy link
Contributor

@sungchun12 sungchun12 commented Dec 19, 2022

Description & motivation

To-do before merge

  • Ensure PR #6271 is merged
  • Update migration guide specific to 1.5
  • Update version blocks for 1.5

Prerelease docs

If this change is related to functionality in a prerelease version of dbt (delete if not applicable):

Checklist

If you added new pages (delete if not applicable):

  • The page has been added to website/sidebars.js
  • The new page has a unique filename

@netlify
Copy link

netlify bot commented Dec 19, 2022

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit f98639a
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/63ee8365c937df0008bc5319
😎 Deploy Preview https://deploy-preview-2601--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address labels Dec 19, 2022
@sungchun12 sungchun12 self-assigned this Dec 19, 2022
@github-actions github-actions bot added size: large This change will more than a week to address and might require more than one person and removed size: medium This change will take up to a week to address labels Dec 21, 2022
@b-per
Copy link
Contributor

b-per commented Dec 21, 2022

As this relates to models only, would it make sense to move it under "for modes", either as a subitem or in "Model Configurations"?

We should also add the ability to set constraints_enabled to the "General configurations" part of the docs for models.

image

@sungchun12
Copy link
Contributor Author

@b-per good call out. I'll make that change for section placement!

@sungchun12 sungchun12 force-pushed the dbt-constraints-docs branch from 7ef6fb3 to 08daa11 Compare January 3, 2023 23:29
@sungchun12
Copy link
Contributor Author

I was about to move the entire constraints_enabled page as a subsection under model configs, but then realized it gets cluttered and makes it hard to discover this information in the first place. I opted to create hyperlinks in the model configs page to the constraints_enabled page to make it easier to digest all the information in one place.

@jtcohen6 jtcohen6 mentioned this pull request Feb 9, 2023
1 task
@sungchun12
Copy link
Contributor Author

I'll wait to merge this closer to 1.5's release as many open issues may be complete and alter how contracts look and feel.

@jtcohen6
Copy link
Collaborator

@sungchun12 Thanks for the strong start here! Mind if I take over these docs from you? I want to take a swing at standing up the "wireframe" for model contracts — something we can share with devs and early beta testers alike — while also calling out the renaming & syntax changes that we have in the pipe.

@sungchun12
Copy link
Contributor Author

@jtcohen6 go ahead and thanks for asking!

@jtcohen6 jtcohen6 changed the base branch from current to jerco/model-contracts February 19, 2023 23:03
@jtcohen6 jtcohen6 changed the base branch from jerco/model-contracts to current February 19, 2023 23:05
@jtcohen6 jtcohen6 changed the base branch from current to jerco/model-contracts February 19, 2023 23:06
@jtcohen6
Copy link
Collaborator

I'm going to merge this into a new branch (jerco/model-contracts) so I can keep working on it there!

@jtcohen6 jtcohen6 marked this pull request as ready for review February 19, 2023 23:09
@jtcohen6 jtcohen6 requested a review from a team as a code owner February 19, 2023 23:09
@jtcohen6 jtcohen6 merged commit 8fa8192 into jerco/model-contracts Feb 19, 2023
@jtcohen6 jtcohen6 deleted the dbt-constraints-docs branch February 19, 2023 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dbt Constraints: Enforce data types, constraints, and checks on SQL table creation
4 participants