Update admonitions to add shortcode #11622
Merged
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
area/helm
type/docs
|
Trivy scan found the following vulnerabilities:
|
JStickler
force-pushed
the
admonitionFormat
branch
2 times, most recently
from
e7ca1c7 to
8058653
Compare
JStickler
force-pushed
the
admonitionFormat
branch
from
8058653 to
7d0db55
Compare
rhnasc
pushed a commit
to inloco/loki
that referenced
this pull request
Apr 12, 2024
**What this PR does / why we need it**: Completing the work that was started in grafana#9409 but not completed because there were multiple variations on how to format notes in the docs source files. We rolled out different colors for admonitions recently, which highlighted that there were still a few notes not using the admonition shortcode. I searched the docs for the following words: * tip * caution * important * warning * note So hopefully I've caught all of the admonitions that weren't using the shortcode.
This was referenced Sep 23, 2024
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.
What this PR does / why we need it:
Completing the work that was started in #9409 but not completed because there were multiple variations on how to format notes in the docs source files. We rolled out different colors for admonitions recently, which highlighted that there were still a few notes not using the admonition shortcode. I searched the docs for the following words:
So hopefully I've caught all of the admonitions that weren't using the shortcode.