From e7938f9983172dde437e46680dafe09ed46b97d2 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 5 Jul 2022 09:59:40 +0100 Subject: [PATCH] Use menuTitle for more user-friendly lists of topics (#2290) * Use menuTitle for more user-friendly lists of topics Signed-off-by: Jack Baldry * Reduce stuttering in menu titles Grafana Mimir is already inferred by context Signed-off-by: Jack Baldry * Replace empty section with link to components I believe the section was intended to enumerate the components but it is empty as there are no subdirectories of this page. Signed-off-by: Jack Baldry * Fixed link reported by doc-validator Signed-off-by: Marco Pracucci * Fixed link Signed-off-by: Marco Pracucci * Apply code review suggestions Co-authored-by: Marco Pracucci Co-authored-by: Marco Pracucci --- docs/sources/migration-guide/_index.md | 2 +- docs/sources/migration-guide/migrating-from-cortex.md | 1 + .../migration-guide/migrating-from-thanos-or-prometheus.md | 2 +- docs/sources/operators-guide/_index.md | 2 +- docs/sources/operators-guide/architecture/_index.md | 2 +- .../architecture/about-grafana-mimir-architecture/index.md | 4 +--- .../operators-guide/architecture/components/_index.md | 2 +- docs/sources/operators-guide/configuring/_index.md | 2 +- .../deploying-grafana-mimir/jsonnet/_index.md | 2 +- .../operators-guide/monitoring-grafana-mimir/_index.md | 4 ++-- .../monitoring-grafana-mimir/dashboards/_index.md | 2 +- .../running-production-environment/_index.md | 4 ++-- .../running-production-environment/scaling-out.md | 2 +- docs/sources/operators-guide/securing/_index.md | 4 ++-- docs/sources/operators-guide/tools/_index.md | 4 ++-- docs/sources/operators-guide/using-exemplars/_index.md | 6 +++--- docs/sources/release-notes/_index.md | 2 +- 17 files changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/sources/migration-guide/_index.md b/docs/sources/migration-guide/_index.md index 3a14ddaa780..fad7cc10c9f 100644 --- a/docs/sources/migration-guide/_index.md +++ b/docs/sources/migration-guide/_index.md @@ -9,4 +9,4 @@ weight: 30 Refer to the following migration guides when you migrate to Grafana Mimir. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/migration-guide/migrating-from-cortex.md b/docs/sources/migration-guide/migrating-from-cortex.md index e2bfa328098..19ffaf351b9 100644 --- a/docs/sources/migration-guide/migrating-from-cortex.md +++ b/docs/sources/migration-guide/migrating-from-cortex.md @@ -1,5 +1,6 @@ --- title: "Migrating from Cortex to Grafana Mimir" +menuTitle: "Migrating from Cortex" description: "Learn how to migrate your deployment of Cortex to Grafana Mimir to simplify the deployment and continued operation of a horizontally scalable, multi-tenant time series database with long-term storage." weight: 10 --- diff --git a/docs/sources/migration-guide/migrating-from-thanos-or-prometheus.md b/docs/sources/migration-guide/migrating-from-thanos-or-prometheus.md index 6e403410b5f..de6073a58db 100644 --- a/docs/sources/migration-guide/migrating-from-thanos-or-prometheus.md +++ b/docs/sources/migration-guide/migrating-from-thanos-or-prometheus.md @@ -1,6 +1,6 @@ --- title: "Migrating from Thanos or Prometheus to Grafana Mimir" -menuTitle: "Migrating from Thanos or Prometheus to Grafana Mimir" +menuTitle: "Migrating from Thanos or Prometheus" description: "Learn how to migrate from Thanos or Prometheus to Grafana Mimir." weight: 10 --- diff --git a/docs/sources/operators-guide/_index.md b/docs/sources/operators-guide/_index.md index c233ada2b59..31f05e3c2e7 100644 --- a/docs/sources/operators-guide/_index.md +++ b/docs/sources/operators-guide/_index.md @@ -23,4 +23,4 @@ The intended audience for this guide includes: This guide contains the following sections: -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/architecture/_index.md b/docs/sources/operators-guide/architecture/_index.md index 29b72f26529..b35675653e0 100644 --- a/docs/sources/operators-guide/architecture/_index.md +++ b/docs/sources/operators-guide/architecture/_index.md @@ -9,4 +9,4 @@ weight: 20 The following topics include overviews of the Grafana Mimir architecture. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/architecture/about-grafana-mimir-architecture/index.md b/docs/sources/operators-guide/architecture/about-grafana-mimir-architecture/index.md index 96dda517246..a80cf5c77c9 100644 --- a/docs/sources/operators-guide/architecture/about-grafana-mimir-architecture/index.md +++ b/docs/sources/operators-guide/architecture/about-grafana-mimir-architecture/index.md @@ -17,9 +17,7 @@ For more information, refer to [Deployment modes]({{< relref "../deployment-mode ## Grafana Mimir components -Most components are stateless and do not require any data persisted between process restarts. Some components are stateful and rely on non-volatile storage to prevent data loss between process restarts. For details about each component, see its page. - -{{< section >}} +Most components are stateless and do not require any data persisted between process restarts. Some components are stateful and rely on non-volatile storage to prevent data loss between process restarts. For details about each component, see its page in [Components]({{< relref "../components/_index.md" >}}). ### The write path diff --git a/docs/sources/operators-guide/architecture/components/_index.md b/docs/sources/operators-guide/architecture/components/_index.md index 99ef8c67bd8..d74844c583a 100644 --- a/docs/sources/operators-guide/architecture/components/_index.md +++ b/docs/sources/operators-guide/architecture/components/_index.md @@ -20,4 +20,4 @@ keywords: Grafana Mimir includes a set of components that interact to form a cluster. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/configuring/_index.md b/docs/sources/operators-guide/configuring/_index.md index 1edf3a5dbaf..f55094718ab 100644 --- a/docs/sources/operators-guide/configuring/_index.md +++ b/docs/sources/operators-guide/configuring/_index.md @@ -11,4 +11,4 @@ keywords: Grafana Mimir's flexibility is achieved through configuration. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/_index.md b/docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/_index.md index 40580fd1a67..6806359602b 100644 --- a/docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/_index.md +++ b/docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/_index.md @@ -15,4 +15,4 @@ keywords: Grafana Labs publishes [Jsonnet](https://jsonnet.org/) files that you can use to deploy Grafana Mimir in [microservices mode]({{< relref "../../architecture/deployment-modes/index.md#microservices-mode" >}}). Jsonnet files are located in the [Mimir repository](https://github.com/grafana/mimir/tree/main/operations/mimir). -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/monitoring-grafana-mimir/_index.md b/docs/sources/operators-guide/monitoring-grafana-mimir/_index.md index 5e4e7d0bdf6..d833c1eca25 100644 --- a/docs/sources/operators-guide/monitoring-grafana-mimir/_index.md +++ b/docs/sources/operators-guide/monitoring-grafana-mimir/_index.md @@ -1,6 +1,6 @@ --- title: "Monitoring Grafana Mimir" -menuTitle: "Monitoring Grafana Mimir" +menuTitle: "Monitoring Mimir" description: "View example Grafana Mimir dashboards." weight: 50 keywords: @@ -13,4 +13,4 @@ aliases: The following topics guide you in preparing your environment to display dashboards that you can use to monitor Grafana Mimir. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/monitoring-grafana-mimir/dashboards/_index.md b/docs/sources/operators-guide/monitoring-grafana-mimir/dashboards/_index.md index bf86a298bf4..ba5388024fd 100644 --- a/docs/sources/operators-guide/monitoring-grafana-mimir/dashboards/_index.md +++ b/docs/sources/operators-guide/monitoring-grafana-mimir/dashboards/_index.md @@ -11,4 +11,4 @@ aliases: Grafana Mimir provides the following production-ready dashboards. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/running-production-environment/_index.md b/docs/sources/operators-guide/running-production-environment/_index.md index fed39b8c7ea..59823866691 100644 --- a/docs/sources/operators-guide/running-production-environment/_index.md +++ b/docs/sources/operators-guide/running-production-environment/_index.md @@ -1,6 +1,6 @@ --- title: "Running Grafana Mimir in production" -menuTitle: "Running Grafana Mimir in production" +menuTitle: "Running in production" description: "Learn how to run Grafana Mimir in production." weight: 80 --- @@ -9,4 +9,4 @@ weight: 80 The following topics provide guidance for you to consider when you run Grafana Mimir in a production environment. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/running-production-environment/scaling-out.md b/docs/sources/operators-guide/running-production-environment/scaling-out.md index e4e34a086fe..2374bfe90fb 100644 --- a/docs/sources/operators-guide/running-production-environment/scaling-out.md +++ b/docs/sources/operators-guide/running-production-environment/scaling-out.md @@ -1,6 +1,6 @@ --- title: "Scaling out Grafana Mimir" -menuTitle: "Scaling out Grafana Mimir" +menuTitle: "Scaling out" description: "Learn how to scale out Grafana Mimir." weight: 30 --- diff --git a/docs/sources/operators-guide/securing/_index.md b/docs/sources/operators-guide/securing/_index.md index aec7df06d7b..a0b1225895e 100644 --- a/docs/sources/operators-guide/securing/_index.md +++ b/docs/sources/operators-guide/securing/_index.md @@ -1,6 +1,6 @@ --- title: "Securing Grafana Mimir" -menuTitle: "Securing Grafana Mimir" +menuTitle: "Securing" description: "Learn how to secure Grafana Mimir data and communication paths." weight: 70 keywords: @@ -15,4 +15,4 @@ keywords: These sections explain how to secure Grafana Mimir data and communication paths. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/tools/_index.md b/docs/sources/operators-guide/tools/_index.md index ade0e47c679..e529eee4daa 100644 --- a/docs/sources/operators-guide/tools/_index.md +++ b/docs/sources/operators-guide/tools/_index.md @@ -1,6 +1,6 @@ --- title: "Grafana Mimir tools" -menuTitle: "Grafana Mimir tools" +menuTitle: "Tools" description: "Tools for Grafana Mimir aid in administration and troubleshooting tasks." weight: 100 --- @@ -9,4 +9,4 @@ weight: 100 Tools for Grafana Mimir aid in administration and troubleshooting tasks. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/operators-guide/using-exemplars/_index.md b/docs/sources/operators-guide/using-exemplars/_index.md index b68c157c765..5cd158580b1 100644 --- a/docs/sources/operators-guide/using-exemplars/_index.md +++ b/docs/sources/operators-guide/using-exemplars/_index.md @@ -1,7 +1,7 @@ --- title: "Using exemplars with Grafana Mimir" -menuTitle: "Using exemplars with Grafana Mimir" -description: "Learn how to use examplars with Grafana Mimir." +menuTitle: "Using exemplars" +description: "Learn how to use exemplars with Grafana Mimir." weight: 40 keywords: - Mimir exemplars @@ -11,4 +11,4 @@ keywords: This following topics describe how to use exemplars to identify higher cardinality metadata from specific events within time series data. -{{< section >}} +{{< section menuTitle="true" >}} diff --git a/docs/sources/release-notes/_index.md b/docs/sources/release-notes/_index.md index 33876a579ab..ba2190a0eac 100644 --- a/docs/sources/release-notes/_index.md +++ b/docs/sources/release-notes/_index.md @@ -9,4 +9,4 @@ keywords: # Grafana Mimir release notes -{{< section >}} +{{< section menuTitle="true" >}}