mimir
mimir copied to clipboard
grafana
Issue 1330 documentation changes
What this PR does
Opened this PR to tackle issue 1330 and fix up the related documentation points.
Which issue(s) this PR fixes or relates to
Fixes #1330
Checklist
- [ ] Tests updated
- [ ] Documentation added
- [ ]
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]
Sorry, clicked the wrong button trying to run the workflow
Ok! Anything i should be doing on my part?
Sorry, clicked the wrong button trying to run the workflow
Ok! Anything i should be doing on my part?
Nope! Feel free to work on this as you see fit and mark it ready when you'd like review
Hey, I think that most parts that could be altered are done so, the ones remaining were in sentences where if I would change them it would seem too weird I think. Still if there are any suggestions I am open!
@pracucci, can you add some rationale as to why there are so many recommendations? I think a little rationale can go a long way.
Hey @osg-grafana, first of all thank you for all the valuable feedback, it's nice getting a bit more insight on the project. I'll go over the changes in the next couple of days and push some change for either approval or more feedback!
The CHANGELOG has just been cut to prepare for the next Mimir release. Please rebase main and eventually move the CHANGELOG entry added / updated in this PR to the top of the CHANGELOG document. Thanks!
@konstantinos-null, @pracucci and I will incorporate the style changes in subsequent PRs as those files are touched. Thank you for providing feedback that we can refer back to.