docs: reference Grafana Agent Flow as an OTel Collector distribution (#…

…6633) (#6660) Signed-off-by: Paschalis Tsilias <[email protected]> Co-authored-by: Clayton Cornell <[email protected]> (cherry picked from commit 4dd7eea)
grafana · Mar 12, 2024 · 26e9071 · 26e9071
1 parent 890d1fa
commit 26e9071
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,8 @@
 <p align="center"><img src="docs/sources/assets/logo_and_name.png" alt="Grafana Agent logo"></p>
 
-Grafana Agent is a vendor-neutral, batteries-included telemetry collector with
-configuration inspired by [Terraform][]. It is designed to be flexible,
-performant, and compatible with multiple ecosystems such as Prometheus and
-OpenTelemetry.
+Grafana Agent is an OpenTelemetry Collector distribution with configuration
+inspired by [Terraform][]. It is designed to be flexible, performant, and
+compatible with multiple ecosystems such as Prometheus and OpenTelemetry.
 
 Grafana Agent is based around **components**. Components are wired together to
 form programmable observability **pipelines** for telemetry collection,

diff --git a/docs/sources/_index.md b/docs/sources/_index.md
@@ -15,10 +15,9 @@ cascade:
 
 # Grafana Agent
 
-Grafana Agent is a vendor-neutral, batteries-included telemetry collector with
-configuration inspired by [Terraform][]. It is designed to be flexible,
-performant, and compatible with multiple ecosystems such as Prometheus and
-OpenTelemetry.
+Grafana Agent is an OpenTelemetry Collector distribution with configuration
+inspired by [Terraform][]. It is designed to be flexible, performant, and
+compatible with multiple ecosystems such as Prometheus and OpenTelemetry.
 
 Grafana Agent is based around **components**. Components are wired together to
 form programmable observability **pipelines** for telemetry collection,

diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t
@@ -15,10 +15,9 @@ cascade:
 
 # Grafana Agent
 
-Grafana Agent is a vendor-neutral, batteries-included telemetry collector with
-configuration inspired by [Terraform][]. It is designed to be flexible,
-performant, and compatible with multiple ecosystems such as Prometheus and
-OpenTelemetry.
+Grafana Agent is an OpenTelemetry Collector distribution with configuration
+inspired by [Terraform][]. It is designed to be flexible, performant, and
+compatible with multiple ecosystems such as Prometheus and OpenTelemetry.
 
 Grafana Agent is based around **components**. Components are wired together to
 form programmable observability **pipelines** for telemetry collection,

diff --git a/docs/sources/flow/_index.md b/docs/sources/flow/_index.md
@@ -33,6 +33,19 @@ Components allow for reusability, composability, and focus on a single task.
 * Use expressions to bind components together to build a programmable pipeline.
 * Includes a UI for debugging the state of a pipeline.
 
+{{< param "PRODUCT_NAME" >}} is a [distribution][] of the OpenTelemetry
+Collector.
+
+Each distribution offers a different collection of components and capabilities.
+As a distribution, {{< param "PRODUCT_NAME" >}} includes dozens of
+OpenTelemetry-native [components][] from the OpenTelemetry project and
+introduces new features such as programmable pipelines, clustering support,
+and the ability to share pipelines around the world.
+
+In addition to being an OpenTelemetry Collector distribution,
+{{< param "PRODUCT_NAME" >}} also includes first-class support for the
+Prometheus and Loki ecosystems, allowing you to mix-and-match your pipelines.
+
 ## Example
 
 ```river
@@ -85,9 +98,19 @@ This feature is experimental, and it doesn't support all River components.
 * Check out our [Reference][] documentation to find specific information you
   might be looking for.
 
-[Install]: {{< relref "./get-started/install/" >}}
-[Concepts]: {{< relref "./concepts/" >}}
-[Tasks]: {{< relref "./tasks/" >}}
-[Tutorials]: {{< relref "./tutorials/ ">}}
-[Reference]: {{< relref "./reference" >}}
-
+[distribution]: https://opentelemetry.io/ecosystem/distributions/
+
+{{% docs/reference %}}
+[Install]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/install/"
+[Install]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/install/"
+[Concepts]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/"
+[Concepts]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/"
+[Tasks]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/"
+[Tasks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/"
+[Tutorials]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tutorials/"
+[Tutorials]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tutorials/
+[Reference]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/"
+[Reference]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/"
+[components]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/"
+[components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components"
+{{% /docs/reference %}}