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

Docs landing page update #7795

Merged
merged 25 commits into from
Jul 3, 2024
Merged

Docs landing page update #7795

merged 25 commits into from
Jul 3, 2024

Conversation

alyssawada
Copy link
Contributor

@alyssawada alyssawada commented Apr 3, 2024

What this PR does

Updates the Mimir docs landing page to implement new page design and card grid layout.

Screenshot 2024-04-08 at 09 45 10

Checklist

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

@alyssawada alyssawada added the type/docs Improvements or additions to documentation label Apr 3, 2024
@alyssawada alyssawada requested review from jdbaldry and a team as code owners April 3, 2024 14:46
@CLAassistant
Copy link

CLAassistant commented Apr 3, 2024

CLA assistant check
All committers have signed the CLA.

docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
@alyssawada alyssawada self-assigned this Apr 4, 2024
@alyssawada
Copy link
Contributor Author

thanks for cleaning those odds and ends up, @jdbaldry! 🙇

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.

LGTM, thanks for incorporating the changes

@alyssawada
Copy link
Contributor Author

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?

@jdbaldry
Copy link
Member

jdbaldry commented Apr 8, 2024

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 Show resolved Hide resolved

## Overview

Experience the capabilities of Grafana Mimir for scalable, cost-effective, and reliable long-term storage of your Prometheus metrics.
Copy link
Contributor

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?

Copy link
Member

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!

Copy link
Contributor

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.

Copy link
Member

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?

Copy link
Contributor

@derek-cadzow derek-cadzow Apr 12, 2024

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.

Copy link
Contributor

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?

Copy link
Contributor

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!)

Copy link
Contributor

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

docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

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

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.
Copy link
Contributor

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

Copy link
Contributor

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.

docs/sources/mimir/_index.md Show resolved Hide resolved
@tacole02
Copy link
Contributor

@alyssawada I'm happy to take this issue on 😄

@tacole02 tacole02 self-assigned this Jun 25, 2024
@alyssawada alyssawada removed their assignment Jun 26, 2024
@tacole02 tacole02 requested a review from krajorama June 27, 2024 23:34
@tacole02
Copy link
Contributor

@krajorama I've updated this PR based on your feedback. Please let me know how it looks!

@krajorama krajorama enabled auto-merge (squash) July 3, 2024 15:27
@krajorama krajorama merged commit 909a08e into main Jul 3, 2024
29 checks passed
@krajorama krajorama deleted the docs-landing-page-update branch July 3, 2024 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants