Use menuTitle for more user-friendly lists of topics (grafana#2290)

* Use menuTitle for more user-friendly lists of topics Signed-off-by: Jack Baldry <[email protected]> * Reduce stuttering in menu titles Grafana Mimir is already inferred by context Signed-off-by: Jack Baldry <[email protected]> * 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 <[email protected]> * Fixed link reported by doc-validator Signed-off-by: Marco Pracucci <[email protected]> * Fixed link Signed-off-by: Marco Pracucci <[email protected]> * Apply code review suggestions Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Marco Pracucci <[email protected]>
udmire · Jul 11, 2022 · e7938f9 · e7938f9
1 parent 8c24b7a
commit e7938f9
Show file tree

Hide file tree

Showing 17 changed files with 23 additions and 24 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -9,4 +9,4 @@ weight: 20
 
 The following topics include overviews of the Grafana Mimir architecture.
 
-{{< section >}}
+{{< section menuTitle="true" >}}
diff --git a/.../sources/operators-guide/architecture/about-grafana-mimir-architecture/index.md b/.../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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -9,4 +9,4 @@ keywords:
 
 # Grafana Mimir release notes
 
-{{< section >}}
+{{< section menuTitle="true" >}}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,4 @@ weight: 30

		Refer to the following migration guides when you migrate to Grafana Mimir.

		{{< section >}}
		{{< section menuTitle="true" >}}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -23,4 +23,4 @@ The intended audience for this guide includes:

		This guide contains the following sections:

		{{< section >}}
		{{< section menuTitle="true" >}}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,4 @@ weight: 20

		The following topics include overviews of the Grafana Mimir architecture.

		{{< section >}}
		{{< section menuTitle="true" >}}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,4 +20,4 @@ keywords:

		Grafana Mimir includes a set of components that interact to form a cluster.

		{{< section >}}
		{{< section menuTitle="true" >}}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,4 +11,4 @@ keywords:

		Grafana Mimir's flexibility is achieved through configuration.

		{{< section >}}
		{{< section menuTitle="true" >}}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,4 +11,4 @@ aliases:

		Grafana Mimir provides the following production-ready dashboards.

		{{< section >}}
		{{< section menuTitle="true" >}}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,4 @@ keywords:

		# Grafana Mimir release notes

		{{< section >}}
		{{< section menuTitle="true" >}}