Add description metadata to Grafana Agent docs (#5296)

* Add description metadata

* Add description metadata to shared content

* Fix the title metadata in fmt

* Update the doc generator tool

* Clean up some metadata errors

docs/sources/_index.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/
 canonical: https://grafana.com/docs/agent/latest/
 title: Grafana Agent
+description: Grafana Agent is a flexible, performant, vendor-neutral, telemetry collector
 weight: 350
 ---
 

docs/sources/about.md

@@ -7,6 +7,7 @@ aliases:
 canonical: https://grafana.com/docs/agent/latest/about/
 menuTitle: Introduction
 title: Introduction to Grafana Agent
+description: Grafana Agent is a flexible, performant, vendor-neutral, telemetry collector
 weight: 100
 ---
 

docs/sources/flow/_index.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/
 canonical: https://grafana.com/docs/agent/latest/flow/
 title: Flow mode
+description: Grafana Agent Flow is a component-based revision of Grafana Agent with a focus on ease-of-use, debuggability, and adaptability
 weight: 400
 ---
 

docs/sources/flow/concepts/_index.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/
 canonical: https://grafana.com/docs/agent/latest/flow/concepts/
 title: Concepts
+description: Learn about the Grafana Agent flow mode concepts
 weight: 100
 ---
 

docs/sources/flow/concepts/clustering.md

@@ -8,6 +8,7 @@ labels:
   stage: beta
 menuTitle: Clustering
 title: Grafana Agent clustering concepts
+description: Learn about Grafana Agent clustering concepts
 weight: 500
 ---
 

docs/sources/flow/concepts/component_controller.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/component_controller/
 canonical: https://grafana.com/docs/agent/latest/flow/concepts/component_controller/
 title: Component controller
+description: Learn about the component controller
 weight: 200
 ---
 
@@ -16,7 +17,7 @@ components at runtime.
 
 It is responsible for:
 
-* Reading and validating the config file.
+* Reading and validating the configuration file.
 * Managing the lifecycle of defined components.
 * Evaluating the arguments used to configure components.
 * Reporting the health of defined components.
@@ -31,7 +32,7 @@ The set of all components and the relationships between them define a [directed
 acyclic graph][DAG] (DAG), which informs the component controller which
 references are valid and in what order components must be evaluated.
 
-For a config file to be valid, components must not reference themselves or
+For a configuration file to be valid, components must not reference themselves or
 contain a cyclic reference:
 
 ```river
@@ -131,10 +132,10 @@ documentation for components to learn if in-memory traffic is supported.
 ## Updating the config file
 
 Both the `/-/reload` HTTP endpoint and the `SIGHUP` signal can be used to
-inform the component controller to reload the config file. When this happens,
+inform the component controller to reload the configuration file. When this happens,
 the component controller will synchronize the set of running components with
-the ones in the config file, removing components which are no longer defined in
-the config file and creating new components which were added to the config
+the ones in the configuration file, removing components which are no longer defined in
+the configuration file and creating new components which were added to the configuration
 file. All components managed by the controller will be reevaluated after
 reloading.
 

docs/sources/flow/concepts/components.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/components/
 canonical: https://grafana.com/docs/agent/latest/flow/concepts/components/
 title: Components
+description: Learn about components
 weight: 100
 ---
 

docs/sources/flow/concepts/configuration_language.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/configuration_language/
 canonical: https://grafana.com/docs/agent/latest/flow/concepts/configuration_language/
 title: Configuration language concepts
+description: Learn about configuration language concepts
 weight: 400
 ---
 

docs/sources/flow/concepts/modules.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/modules/
 canonical: https://grafana.com/docs/agent/latest/flow/concepts/modules/
 title: Modules
+description: Learn about modules
 weight: 300
 ---
 

docs/sources/flow/config-language/_index.md

@@ -6,6 +6,7 @@ aliases:
 - configuration-language/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/
 title: Configuration language
+description: Learn about the configuration language
 weight: 400
 ---
 

docs/sources/flow/config-language/components.md

@@ -5,11 +5,12 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/agent/flow/config-language/components/
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/components/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/components/
-title: Components config language
+title: Components configuration language
+description: Learn about the components configuration language
 weight: 300
 ---
 
-# Components config language
+# Components configuration language
 Components are the defining feature of Grafana Agent Flow. They are small,
 reusable pieces of business logic that perform a single task (like retrieving
 secrets or collecting Prometheus metrics) and can be wired together to form

docs/sources/flow/config-language/expressions/_index.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/expressions/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/expressions/
 title: Expressions
+description: Learn about expressions
 weight: 400
 ---
 

docs/sources/flow/config-language/expressions/function_calls.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/expressions/function_calls/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/expressions/function_calls/
 title: Function calls
+description: Learn about function calls
 weight: 400
 ---
 

docs/sources/flow/config-language/expressions/operators.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/expressions/operators/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/expressions/operators/
 title: Operators
+description: Learn about operators
 weight: 300
 ---
 

docs/sources/flow/config-language/expressions/referencing_exports.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/expressions/referencing_exports/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/expressions/referencing_exports/
 title: Referencing component exports
+description: Learn about referencing component exports
 weight: 200
 ---
 

docs/sources/flow/config-language/expressions/types_and_values.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/expressions/types_and_values/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/expressions/types_and_values/
 title: Types and values
+description: Learn about the River types and values
 weight: 100
 ---
 

docs/sources/flow/config-language/files.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/files/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/files/
 title: Files
+description: Learn about River files
 weight: 100
 ---
 

docs/sources/flow/config-language/syntax.md

@@ -6,6 +6,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/config-language/syntax/
 canonical: https://grafana.com/docs/agent/latest/flow/config-language/syntax/
 title: Syntax
+description: Learn about the River syntax
 weight: 200
 ---
 

docs/sources/flow/getting-started/_index.md

@@ -7,6 +7,7 @@ aliases:
 canonical: https://grafana.com/docs/agent/latest/flow/getting-started/
 menuTitle: Get started
 title: Get started with Grafana Agent in flow mode
+description: Learn how to use Grafana Agent in flow mode
 weight: 200
 ---
 

docs/sources/flow/getting-started/collect-opentelemetry-data.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/collect-opentelemetry-data/
 canonical: https://grafana.com/docs/agent/latest/flow/getting-started/collect-opentelemetry-data/
 title: Collect OpenTelemetry data
+description: Learn how to collect OpenTelemetry data
 weight: 300
 ---
 

docs/sources/flow/getting-started/collect-prometheus-metrics.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/collect-prometheus-metrics/
 canonical: https://grafana.com/docs/agent/latest/flow/getting-started/collect-prometheus-metrics/
 title: Collect and forward Prometheus metrics
+description: Learn how to collect and forward Prometheus metrics
 weight: 200
 ---
 

docs/sources/flow/getting-started/configure-agent-clustering.md

@@ -6,6 +6,7 @@ aliases:
 canonical: https://grafana.com/docs/agent/latest/flow/getting-started/configure-agent-clustering/
 menuTitle: Configure Grafana Agent clustering
 title: Configure Grafana Agent clustering in an existing installation
+description: Learn how to configure Grafana Agent clustering in an existing installation
 weight: 400
 ---
 

docs/sources/flow/getting-started/distribute-prometheus-scrape-load.md

@@ -6,6 +6,7 @@ aliases:
 canonical: https://grafana.com/docs/agent/latest/flow/getting-started/distribute-prometheus-scrape-load/
 menuTitle: Distribute Prometheus metrics scrape load
 title: Distribute your Prometheus metrics scrape load
+description: Learn how to distribute your Prometheus metrics scrape load
 weight: 500
 ---
 

docs/sources/flow/getting-started/migrating-from-prometheus.md

@@ -8,6 +8,7 @@ description: Learn how to migrate your configuration from Prometheus to Grafana
   flow mode
 menuTitle: Migrate from Prometheus
 title: Migrate from Prometheus to Grafana Agent flow mode
+description: Learn how to migrate from Prometheus to Grafana Agent flow mode
 weight: 320
 ---
 

docs/sources/flow/getting-started/migrating-from-promtail.md

@@ -7,7 +7,8 @@ canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-
 description: Learn how to migrate your configuration from Promtail to Grafana Agent
   Flow Mode
 menuTitle: Migrate from Promtail
-title: Migrate from Promtail to Grafana Agent Flow Mode
+title: Migrate from Promtail to Grafana Agent Flow mode
+description: Learn how to migrate from Promtail to Grafana Agent Flow mode
 weight: 330
 ---
 

docs/sources/flow/getting-started/opentelemetry-to-lgtm-stack.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/opentelemetry-to-lgtm-stack/
 canonical: https://grafana.com/docs/agent/latest/flow/getting-started/opentelemetry-to-lgtm-stack/
 title: OpenTelemetry to Grafana stack
+description: Learn how to collect OpenTelemetry data and forward it to the Grafana stack
 weight: 350
 ---
 

docs/sources/flow/monitoring/_index.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/monitoring/
 canonical: https://grafana.com/docs/agent/latest/flow/monitoring/
 title: Monitoring Grafana Agent Flow
+description: Learn about monitoring Grafana Agent Flow
 weight: 500
 ---
 

docs/sources/flow/monitoring/component_metrics.md

@@ -6,6 +6,7 @@ aliases:
 - component-metrics/
 canonical: https://grafana.com/docs/agent/latest/flow/monitoring/component_metrics/
 title: Component metrics
+description: Learn about component metrics
 weight: 200
 ---
 

docs/sources/flow/monitoring/controller_metrics.md

@@ -6,6 +6,7 @@ aliases:
 - controller-metrics/
 canonical: https://grafana.com/docs/agent/latest/flow/monitoring/controller_metrics/
 title: Controller metrics
+description: Learn about controller metrics
 weight: 100
 ---
 

docs/sources/flow/monitoring/debugging.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/monitoring/debugging/
 canonical: https://grafana.com/docs/agent/latest/flow/monitoring/debugging/
 title: Debugging
+description: Learn about debugging
 weight: 300
 ---
 

docs/sources/flow/reference/_index.md

@@ -4,7 +4,9 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/
 canonical: https://grafana.com/docs/agent/latest/flow/reference/
-title: Reference
+title: Grafana Agent Flow Reference
+menuTitle: Reference
+description: The reference-level documentaiton for Grafana Agent
 weight: 600
 ---
 

docs/sources/flow/reference/cli/_index.md

@@ -8,6 +8,7 @@ description: The Grafana Agent command line interface provides subcommands to pe
   various operations.
 menuTitle: Command-line interface
 title: The Grafana Agent command line interface
+description: Learn about the Grafana Agent command line interface
 weight: 100
 ---
 

docs/sources/flow/reference/cli/convert.md

@@ -9,17 +9,18 @@ description: The `convert` command converts supported configuration formats to R
 labels:
   stage: beta
 menuTitle: convert
-title: convert command
+title: The convert command
+description: Learn about the convert command
 weight: 100
 ---
 
-# `convert` command
+# The convert command
 
 The `convert` command converts a supported configuration format to Grafana Agent Flow River format.
 
 ## Usage
 
-Usage: 
+Usage:
 
 * `AGENT_MODE=flow grafana-agent convert [FLAG ...] FILE_NAME`
 * `grafana-agent-flow convert [FLAG ...] FILE_NAME`

docs/sources/flow/reference/cli/fmt.md

@@ -6,11 +6,12 @@ aliases:
 canonical: https://grafana.com/docs/agent/latest/flow/reference/cli/fmt/
 description: The `fmt` command formats a Grafana Agent configuration file.
 menuTitle: fmt
-title: fmt command
+title: The fmt command
+description: Learn about the fmt command
 weight: 200
 ---
 
-# `fmt` command
+# The fmt command
 
 The `fmt` command formats a given Grafana Agent Flow configuration file.
 

docs/sources/flow/reference/cli/run.md

@@ -7,11 +7,12 @@ canonical: https://grafana.com/docs/agent/latest/flow/reference/cli/run/
 description: The `run` command runs Grafana Agent in the foreground until an interrupt
   is received.
 menuTitle: run
-title: run command
+title: The run command
+description: Learn about the run command
 weight: 300
 ---
 
-# `run` command
+# The run command
 
 The `run` command runs Grafana Agent Flow in the foreground until an
 interrupt is received.

docs/sources/flow/reference/cli/tools.md

@@ -6,11 +6,12 @@ aliases:
 canonical: https://grafana.com/docs/agent/latest/flow/reference/cli/tools/
 description: Command line tools that read the WAL and provide statistical information.
 menuTitle: tools
-title: tools command
+title: The tools command
+description: Learn about the tools command
 weight: 400
 ---
 
-# `tools` command
+# The tools command
 
 The `tools` command contains command line tooling grouped by Flow component.
 

docs/sources/flow/reference/components/_index.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/components/
 canonical: https://grafana.com/docs/agent/latest/flow/reference/components/
 title: Components reference
+description: Learn about the compenets in Grafana Agent
 weight: 300
 ---
 

docs/sources/flow/reference/components/discovery.azure.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/components/discovery.azure/
 canonical: https://grafana.com/docs/agent/latest/flow/reference/components/discovery.azure/
 title: discovery.azure
+description: Learn about discovery.azure
 ---
 
 # discovery.azure

docs/sources/flow/reference/components/discovery.consul.md

@@ -5,6 +5,7 @@ aliases:
 - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/components/discovery.consul/
 canonical: https://grafana.com/docs/agent/latest/flow/reference/components/discovery.consul/
 title: discovery.consul
+description: Learn about discovery.consul
 ---
 
 # discovery.consul

docs/sources/flow/reference/components/discovery.consulagent.md

@@ -1,6 +1,7 @@
 ---
 canonical: https://grafana.com/docs/agent/latest/flow/reference/components/discovery.consulagent/
 title: discovery.consulagent
+description: Learn about discovery.consulagent
 ---
 
 # discovery.consulagent