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 docs links + slightly tweak language for behavior change deprecations #10077

Merged
merged 4 commits into from
May 6, 2024

Conversation

jtcohen6
Copy link
Contributor

@jtcohen6 jtcohen6 commented May 2, 2024

follow-up to #10063

Cosmetic change only, no changes to functionality.

Problem

We have a docs page that details legacy behaviors, which we're deprecating / changing via "behavior change flags":

The docs team decided (rightly) that the super-long anchors weren't a good look in dbt-labs/docs.getdbt.com#5389. Now it looks like this (better):

Screenshot 2024-05-02 at 13 37 35

Solution

Instead of linking to specific anchors, just link to the docs page. This looks much cleaner in the logs. If we start having too many of these flags (more than a dozen), we can handle via better navigation within the docs site.

🎩
Screenshot 2024-05-02 at 13 28 18

Checklist

  • I have read the contributing guide and understand what's expected of me
  • I have run this code in development and it appears to resolve the stated issue
  • This PR includes tests, or tests are not required/relevant for this PR
  • This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX
  • This PR includes type annotations for new and modified functions

@jtcohen6 jtcohen6 requested a review from emmyoop May 2, 2024 11:36
@jtcohen6 jtcohen6 requested a review from a team as a code owner May 2, 2024 11:36
@cla-bot cla-bot bot added the cla:yes label May 2, 2024
Copy link
Contributor

github-actions bot commented May 2, 2024

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

Copy link

codecov bot commented May 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.21%. Comparing base (65791e4) to head (5a1aaf7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10077   +/-   ##
=======================================
  Coverage   88.21%   88.21%           
=======================================
  Files         181      181           
  Lines       22748    22749    +1     
=======================================
+ Hits        20068    20069    +1     
  Misses       2680     2680           
Flag Coverage Δ
integration 85.60% <100.00%> (-0.01%) ⬇️
unit 62.64% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jtcohen6 jtcohen6 added the Skip Changelog Skips GHA to check for changelog file label May 2, 2024
@jtcohen6 jtcohen6 added the artifact_minor_upgrade To bypass the CI check by confirming that the change is not breaking label May 6, 2024
@jtcohen6 jtcohen6 merged commit fb6dbc8 into main May 6, 2024
67 of 68 checks passed
@jtcohen6 jtcohen6 deleted the jerco/update-deprecation-docs-links branch May 6, 2024 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
artifact_minor_upgrade To bypass the CI check by confirming that the change is not breaking cla:yes Skip Changelog Skips GHA to check for changelog file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants