docs: fix metrics page admonitions and other tidying #13632
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
Signed-off-by: Alan Clucas <[email protected]>
agilgur5
changed the title
agilgur5
approved these changes
Sep 20, 2024
There was a problem hiding this comment.
LGTM. For context, @Joibel noticed these before and I noticed them during the previous Contributor Meeting with Alan. I hadn't fully reviewed #13232 to catch these before
agilgur5
changed the title
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.
Tidies metrics page
Motivation
The metrics page doesn't do material admonitions correctly
Also addressing a couple of other issues on that page.
Modifications
Title of metrics page changed from
Prometheus Metricsto justMetricsto show it's new roleTwo badly done !!! sections fixed, one shown above. Also modified
workflow-creator.mdto change NOTE->Note to match style of the rest of the !!! admonitionsAdded spacing around markdown comment as requested before.
Verification
Ran
make docsand viewed both pages to ensure they looked correct at all changed points.