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

Update behavior change format on upgrade guides #6543

Open
1 task done
mirnawong1 opened this issue Nov 26, 2024 · 0 comments
Open
1 task done

Update behavior change format on upgrade guides #6543

mirnawong1 opened this issue Nov 26, 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

@mirnawong1
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

Per @matthewshaver 's comment in this PR review, he suggests that we either link to the section that explains what Introduced means or remove it when writing about behavior flags/changes? He mentions that using those words stands out and raises questions. Maybe these could say Disabled by default after the feature name rather than before.

It looks like a previous upgrade guide uses the same format: https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.8#managing-changes-to-legacy-behaviors so raising an issue to address this overall.

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

https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.8#managing-changes-to-legacy-behaviors
https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.9#new-and-changed-features-and-functionality

Additional information

No response

@mirnawong1 mirnawong1 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Nov 26, 2024
@mirnawong1 mirnawong1 changed the title Update upgrade guides Update behavior change format on upgrade guides Nov 26, 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