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

Create a common snippet for breaking changes for model contracts #6198

Open
1 task done
dbeatty10 opened this issue Oct 1, 2024 · 0 comments
Open
1 task done

Create a common snippet for breaking changes for model contracts #6198

dbeatty10 opened this issue Oct 1, 2024 · 0 comments
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@dbeatty10
Copy link
Contributor

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

There are two pages with common language that has slightly diverged (search for "Removing an existing column"):

  1. website/docs/docs/collaborate/govern/model-contracts.md
  2. website/docs/reference/resource-properties/versions.md

Some of the behavior has changed across versions (e.g. v1.6 and 1.9), so that makes it a little tricky to figure out how best to write this, especially since <Version> blocks have an awkward extra newline when they are with a list of bullet points.

What part(s) of the page would you like to see updated?

It looks like we can combine these two to share the same snippet:

https://docs.getdbt.com/reference/resource-properties/versions#detecting-breaking-changes

image

https://docs.getdbt.com/docs/collaborate/govern/model-contracts#how-are-breaking-changes-handled

image

Additional information

See #6119 (review)

@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Oct 1, 2024
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 improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

No branches or pull requests

1 participant