-
Notifications
You must be signed in to change notification settings - Fork 60k
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
Fix inconsistent alerts by using the markdown notation - part 1 #35220
Merged
nguyenalex836
merged 2 commits into
github:main
from
akordowski:fix/unify-docs-alerts-part-1
Nov 7, 2024
Merged
Fix inconsistent alerts by using the markdown notation - part 1 #35220
nguyenalex836
merged 2 commits into
github:main
from
akordowski:fix/unify-docs-alerts-part-1
Nov 7, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
triage
Do not begin working on this issue until triaged by the team
label
Nov 7, 2024
1 task
nguyenalex836
added
content
This issue or pull request belongs to the Docs Content team
and removed
triage
Do not begin working on this issue until triaged by the team
labels
Nov 7, 2024
@akordowski Reviewing this now - thank you so much for breaking up that PR! ✨ |
nguyenalex836
approved these changes
Nov 7, 2024
Part 1 approved! 💛 I'll update the branch and get this merged once tests are passing 🍏 |
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why:
As described in the issue #35195 the display of alerts is inconsistent across the documentation.
As the original PR #35216 exceeds the linter limit of 300 files, this PR is part 1 of the changes. It provides changes to alerts across the documentation according to the docs guidelines using the Markdown notation.
What's being changed (if available, include any code snippets, screenshots, or gifs):
Alerts for
note
,tip
,important
andwarning
have been changed and unified from the liquid notation ({% note %}
) to the Markdown notation (> [!NOTE]
) according to the docs guidelines.Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
data
directory.For content changes, I have completed the self-review checklist.