-
Notifications
You must be signed in to change notification settings - Fork 544
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
Add more steps to the play with grafana mimir page #7859
Conversation
I've fleshed out the steps slightly, as this is my (and others') first time through, and one doesn't often know what is needed
There are other issues in the "play with grafana" page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for the fixes :-).
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated to your change but since we are here, it may be nice to get the style in-keeping with Writers' Toolkit guidelines.
-
bold is used for UI elements: https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold.
-
We can make use of the Markdown renderer knowing how to auto-increment list numbers and just
1.
as the number for each step: https://grafana.com/docs/writers-toolkit/write/markdown-guide/#numbered-lists
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
Outdated
Show resolved
Hide resolved
Indeed it was! Co-authored-by: Joshua Hesketh <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs changes look good from a style perspective
I've fleshed out the steps slightly, as this is my (and others') first time through, and one doesn't often know what is needed.
What this PR does
Adds a clarification to instructions which can be unclear the first time one does it.
As this is a demonstration recommended to new adopters, a lot of first-time users
will be trying it.
Which issue(s) this PR fixes or relates to
/docs/sources/mimir/get-started/play-with-grafana-mimir/index.md #7844 in which I
failed to guess the right option, and had to ask
Fixes #7844
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]
.about-versioning.md
updated with experimental features.