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

Add more steps to the play with grafana mimir page #7859

Merged
merged 12 commits into from
Apr 17, 2024

Conversation

davecb
Copy link
Contributor

@davecb davecb commented Apr 9, 2024

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

  • Tests updated.
  • [ x ] Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

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
@davecb davecb requested review from jdbaldry and a team as code owners April 9, 2024 15:44
@CLAassistant
Copy link

CLAassistant commented Apr 9, 2024

CLA assistant check
All committers have signed the CLA.

@davecb
Copy link
Contributor Author

davecb commented Apr 9, 2024

There are other issues in the "play with grafana" page.
For example, the section on doing a reporting rule is (nearly?) identical to the section on alert rules

Copy link
Contributor

@jhesketh jhesketh left a 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 :-).

Copy link
Member

@jdbaldry jdbaldry left a 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.

@56quarters 56quarters requested a review from jdbaldry April 17, 2024 14:34
Copy link
Member

@jdbaldry jdbaldry left a 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

@56quarters 56quarters merged commit 91c0c36 into grafana:main Apr 17, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs feedback: /docs/sources/mimir/get-started/play-with-grafana-mimir/index.md
5 participants