-
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
Docs landing page update #7795
Docs landing page update #7795
Conversation
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]>
thanks for cleaning those odds and ends up, @jdbaldry! 🙇 |
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.
LGTM, thanks for incorporating the changes
hey there👋 looks like we need a codeowners review to get this over the line. could someone from @grafana/mimir-maintainers give this a review, please? |
Yeah, I don't have write permissions (and don't really want to be part of @grafana/mimir-maintainers to get them because of the number of notifications I'd need to ignore. I'll post in the #mimir-reviews channel since it should be an easy LGTM. |
docs/sources/mimir/_index.md
Outdated
|
||
## Overview | ||
|
||
Experience the capabilities of Grafana Mimir for scalable, cost-effective, and reliable long-term storage of your Prometheus metrics. |
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.
this leaves out things and generally looks less impressive to me - was it discussed with PM?
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.
Good question on the copy. @alyssawada I was assuming this came out of a PM discussion but you know what they say about assuming!
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.
@krajorama This was essentially a training task for me to learn how to do the landing pages, with the intent of updating the descriptive information afterward. I was delayed in handling another issue, but I intend to update the descriptions this week and this will be done in conjunction with the dev team/PM. Thanks for the input though, I'll certainly use it as I update the content. If you've any other suggestions, I'll gladly take them.
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.
Coming back to this, I believe @zhehao-grafana has approved the landing page changes or at least the plan to.
@zhehao-grafana would you like to take a look at the changes in this PR and confirm you are happy with them?
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.
@zhehao-grafana @krajorama Alternate possibilities for the tiles (these are taken from the web report that shows the Mimir pages most accessed by users):
1 Grafana Mimir configuration parameters
2 Get started with Grafana Mimir (already have this one)
3 Grafana Mimir HTTP API
4. Get started with Grafana Mimir using the Helm chart
5. Grafana Mimir architecture
6. Grafana Mimirtool
7. Grafana Mimir runbooks
8. Set up Mimir
If any of these would be preferred over what's there now, I can change out the existing tiles and update the text with your help and contributions. Of course, any of the tiles can be updated at any time.
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.
I think this depends on what you want to achieve, easy access to most searched stuff , give overview, promote some features?
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.
@krajorama The main objective in the change to the new landing page layout is to help users find information, so the tiles are meant to be a navigational aid to the information they're looking for (which will save them time searching for it). In the old format, the landing page had more marketing-type information, which doesn't work when someone is coming to these pages to find out how to do something (and sometimes needs to find it quickly!)
Signed-off-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.
I think this is better, but I think we should also highlight OpenTelemetry and ingestion. Also looking for PM feedback from @zhehao-grafana
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.
Approving, with one wording change suggestion.
docs/sources/mimir/_index.md
Outdated
height: 24 | ||
- title: Set up and configure | ||
href: ./configure/about-configurations/ | ||
description: Set up Grafana Mimir with Helm, Puppet, or Jsonnet and Tanka. Migrate to Grafana Mimir from Cortex, Thanos, or Prometheus. Configure Grafana Mimir through the use of a YAML-based configuration file or CLI flags and learn about the common configurations. |
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.
./configure/about-configurations/
isn't about Helm, Puppet etc, it's just a page explaining the YAML configuration
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.
It seems like we're currently grouping the "Set up" and "Configure" docs together here and perhaps conflating the content of these two sections. I'm going to split them into two separate tiles.
@alyssawada I'm happy to take this issue on 😄 |
Co-authored-by: George Krajcsovits <[email protected]>
Co-authored-by: George Krajcsovits <[email protected]>
Co-authored-by: Kim Nylander <[email protected]>
@krajorama I've updated this PR based on your feedback. Please let me know how it looks! |
Signed-off-by: György Krajcsovits <[email protected]>
What this PR does
Updates the Mimir docs landing page to implement new page design and card grid layout.
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]
.about-versioning.md
updated with experimental features.