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

Docs: Remove "(deprecated)" & "(required)" from headings #23060

Merged
merged 2 commits into from
Jun 21, 2023

Conversation

kylegach
Copy link
Contributor

What I did

  • Removed to ensure heading anchor links are stable over time
  • Consistently display deprecated & required properties throughout API references
    • Matches experimental label

How to test

  1. Follow the steps in the contributing instructions for this branch, no-deprecated-in-headings

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@kylegach kylegach added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jun 14, 2023
@kylegach kylegach self-assigned this Jun 14, 2023
- Removed to ensure heading anchor links are stable over time
- Consistently display deprecated properties throughout API references
- Removed to ensure heading anchor links are stable over time
- Consistently display required properties throughout API references
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kylegach looks great. This is a nice touch

@kylegach kylegach merged commit 0fd5665 into next Jun 21, 2023
@kylegach kylegach deleted the no-deprecated-in-headings branch June 21, 2023 14:44
JReinhold pushed a commit that referenced this pull request Jun 21, 2023
Docs: Remove "(deprecated)" & "(required)" from headings
(cherry picked from commit 0fd5665)
@github-actions github-actions bot mentioned this pull request Jun 21, 2023
20 tasks
JReinhold pushed a commit that referenced this pull request Jun 21, 2023
Docs: Remove "(deprecated)" & "(required)" from headings
(cherry picked from commit 0fd5665)
JReinhold pushed a commit that referenced this pull request Jun 22, 2023
Docs: Remove "(deprecated)" & "(required)" from headings
(cherry picked from commit 0fd5665)
@github-actions github-actions bot mentioned this pull request Jun 22, 2023
18 tasks
This was referenced Jul 2, 2023
@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants