Refactor Alloy component reference TOC to group by type (#1215) (#1246)

Co-authored-by: Piotr Gwizdala <[email protected]>
(cherry picked from commit 1ae5fb2)

docs/Makefile

@@ -11,7 +11,7 @@ include docs.mk
 docs: check-cloudwatch-integration
 
 check-cloudwatch-integration:
-	$(PODMAN) run -v $(shell git rev-parse --show-toplevel):/repo -v $(shell pwd):/docs -w /repo golang:1.22.3-bullseye go run internal/static/integrations/cloudwatch_exporter/docs/doc.go check /docs/sources/reference/components/prometheus.exporter.cloudwatch.md
+	$(PODMAN) run -v $(shell git rev-parse --show-toplevel):/repo -v $(shell pwd):/docs -w /repo golang:1.22.3-bullseye go run internal/static/integrations/cloudwatch_exporter/docs/doc.go check /docs/sources/reference/components/prometheus/prometheus.exporter.cloudwatch.md
 
 generate-cloudwatch-integration:
 	$(PODMAN) run -v $(shell git rev-parse --show-toplevel):/repo -v $(shell pwd):/docs -w /repo golang:1.22.3-bullseye go run internal/static/integrations/cloudwatch_exporter/docs/doc.go generate

docs/sources/reference/components/_index.md

@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/
 description: Learn about the components in Grafana Alloy
-title: Components reference
+title: Components
 weight: 300
 ---
 
-# Components reference
+# Components
 
 This section contains reference documentation for all recognized [components][].
 
 {{< section >}}
 
-[components]: ../../concepts/components/
+[components]: ../../get-started/components/

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

@@ -0,0 +1,12 @@
+---
+canonical: https://grafana.com/docs/alloy/latest/reference/components/beyla/
+description: Learn about the beyla components in Grafana Alloy
+title: beyla
+weight: 100
+---
+
+# beyla
+
+This section contains reference documentation for the `beyla` components.
+
+{{< section >}}

docs/sources/reference/components/beyla.ebpf.md → docs/sources/reference/components/beyla/beyla.ebpf.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/beyla.ebpf/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/beyla/beyla.ebpf/
+aliases:
+  - ../beyla.ebpf/ # /docs/alloy/latest/reference/components/beyla.ebpf/
 description: Learn about beyla.ebpf
 title: beyla.ebpf
 ---
@@ -262,21 +264,21 @@ Replace the following:
 [discovery]: #discovery-block
 [services]: #services-block
 [output]: #output-block
-[in-memory traffic]: ../../../concepts/component_controller#in-memory-traffic
-[run command]: ../../cli/run/
-[scrape]: ../prometheus.scrape/
+[in-memory traffic]: ../../../../get-started/component_controller#in-memory-traffic
+[run command]: ../../../cli/run/
+[scrape]: ../../prometheus/prometheus.scrape/
 
 <!-- START GENERATED COMPATIBLE COMPONENTS -->
 
 ## Compatible components
 
 `beyla.ebpf` can accept arguments from the following components:
 
-- Components that export [OpenTelemetry `otelcol.Consumer`](../../compatibility/#opentelemetry-otelcolconsumer-exporters)
+- Components that export [OpenTelemetry `otelcol.Consumer`](../../../compatibility/#opentelemetry-otelcolconsumer-exporters)
 
 `beyla.ebpf` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

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

@@ -0,0 +1,12 @@
+---
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/
+description: Learn about the discovery components in Grafana Alloy
+title: discovery
+weight: 100
+---
+
+# discovery
+
+This section contains reference documentation for the `discovery` components.
+
+{{< section >}}

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

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.azure/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.azure/
+aliases:
+  - ../discovery.azure/ # /docs/alloy/latest/reference/components/discovery.azure/
 description: Learn about discovery.azure
 title: discovery.azure
 ---
@@ -156,7 +158,7 @@ Replace the following:
 
 `discovery.azure` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

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

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.consul/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.consul/
+aliases:
+  - ../discovery.consul/ # /docs/alloy/latest/reference/components/discovery.consul/
 description: Learn about discovery.consul
 title: discovery.consul
 ---
@@ -171,7 +173,7 @@ Replace the following:
 
 `discovery.consul` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

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

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.consulagent/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.consulagent/
+aliases:
+  - ../discovery.consulagent/ # /docs/alloy/latest/reference/components/discovery.consulagent/
 description: Learn about discovery.consulagent
 title: discovery.consulagent
 ---
@@ -132,7 +134,7 @@ Replace the following:
 
 `discovery.consulagent` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.digitalocean.md → docs/sources/reference/components/discovery/discovery.digitalocean.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.digitalocean/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.digitalocean/
+aliases:
+  - ../discovery.digitalocean/ # /docs/alloy/latest/reference/components/discovery.digitalocean/
 description: Learn about discovery.digitalocean
 title: discovery.digitalocean
 ---
@@ -126,7 +128,7 @@ Replace the following:
 
 `discovery.digitalocean` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.dns.md → docs/sources/reference/components/discovery/discovery.dns.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.dns/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.dns/
+aliases:
+  - ../discovery.dns/ # /docs/alloy/latest/reference/components/discovery.dns/
 description: Learn about discovery.dns
 title: discovery.dns
 ---
@@ -94,7 +96,7 @@ Replace the following:
 
 `discovery.dns` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.docker.md → docs/sources/reference/components/discovery/discovery.docker.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.docker/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.docker/
+aliases:
+  - ../discovery.docker/ # /docs/alloy/latest/reference/components/discovery.docker/
 description: Learn about discovery.docker
 title: discovery.docker
 ---
@@ -212,7 +214,7 @@ Replace the following:
 
 `discovery.docker` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.dockerswarm.md → docs/sources/reference/components/discovery/discovery.dockerswarm.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.dockerswarm/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.dockerswarm/
+aliases:
+  - ../discovery.dockerswarm/ # /docs/alloy/latest/reference/components/discovery.dockerswarm/
 description: Learn about discovery.dockerswarm
 title: discovery.dockerswarm
 ---
@@ -260,7 +262,7 @@ Replace the following:
 
 `discovery.dockerswarm` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.ec2.md → docs/sources/reference/components/discovery/discovery.ec2.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.ec2/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.ec2/
+aliases:
+  - ../discovery.ec2/ # /docs/alloy/latest/reference/components/discovery.ec2/
 description: Learn about discovery.ec2
 title: discovery.ec2
 ---
@@ -177,7 +179,7 @@ Replace the following:
 
 `discovery.ec2` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.eureka.md → docs/sources/reference/components/discovery/discovery.eureka.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.eureka/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.eureka/
+aliases:
+  - ../discovery.eureka/ # /docs/alloy/latest/reference/components/discovery.eureka/
 description: Learn about discovery.eureka
 title: discovery.eureka
 ---
@@ -159,7 +161,7 @@ Replace the following:
 
 `discovery.eureka` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.file.md → docs/sources/reference/components/discovery/discovery.file.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.file/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.file/
+aliases:
+  - ../discovery.file/ # /docs/alloy/latest/reference/components/discovery.file/
 description: Learn about discovery.file
 title: discovery.file
 ---
@@ -11,7 +13,7 @@ In {{< param "PRODUCT_NAME" >}} `v0.35.0`, the `discovery.file` component was re
 
 If you are trying to discover files on the local filesystem rather than scrape targets within a set of files, you should use [local.file_match][] instead.
 
-[local.file_match]: ../local.file_match/
+[local.file_match]: ../../local/local.file_match/
 {{< /admonition >}}
 
 `discovery.file` discovers targets from a set of files, similar to the [Prometheus file_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#file_sd_config).
@@ -170,7 +172,7 @@ Replace the following:
 
 `discovery.file` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.gce.md → docs/sources/reference/components/discovery/discovery.gce.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.gce/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.gce/
+aliases:
+  - ../discovery.gce/ # /docs/alloy/latest/reference/components/discovery.gce/
 description: Learn about discovery.gce
 title: discovery.gce
 ---
@@ -119,7 +121,7 @@ Replace the following:
 
 `discovery.gce` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.hetzner.md → docs/sources/reference/components/discovery/discovery.hetzner.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.hetzner/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.hetzner/
+aliases:
+  - ../discovery.hetzner/ # /docs/alloy/latest/reference/components/discovery.hetzner/
 description: Learn about discovery.hetzner
 title: discovery.hetzner
 ---
@@ -183,7 +185,7 @@ Replace the following:
 
 `discovery.hetzner` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.http.md → docs/sources/reference/components/discovery/discovery.http.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.http/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.http/
+aliases:
+  - ../discovery.http/ # /docs/alloy/latest/reference/components/discovery.http/
 description: Learn about discovery.http
 title: discovery.http
 ---
@@ -28,7 +30,7 @@ Example response body:
 
 It is possible to use additional fields in the JSON to pass parameters to [prometheus.scrape][] such as the `metricsPath` and `scrape_interval`.
 
-[prometheus.scrape]: ../prometheus.scrape/#technical-details
+[prometheus.scrape]: ../../prometheus/prometheus.scrape/#technical-details
 
 As an example, the following will provide a target with a custom `metricsPath`, scrape interval, and timeout value:
 
@@ -192,7 +194,7 @@ discovery.http "dynamic_targets" {
 
 `discovery.http` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.ionos.md → docs/sources/reference/components/discovery/discovery.ionos.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.ionos/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.ionos/
+aliases:
+  - ../discovery.ionos/ # /docs/alloy/latest/reference/components/discovery.ionos/
 description: Learn about discovery.ionos
 title: discovery.ionos
 ---
@@ -158,7 +160,7 @@ Replace the following:
 
 `discovery.ionos` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.kubelet.md → docs/sources/reference/components/discovery/discovery.kubelet.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.kubelet/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.kubelet/
+aliases:
+  - ../discovery.kubelet/ # /docs/alloy/latest/reference/components/discovery.kubelet/
 description: Learn about discovery.kubelet
 title: discovery.kubelet
 ---
@@ -214,7 +216,7 @@ Replace the following:
 
 `discovery.kubelet` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.

docs/sources/reference/components/discovery.kubernetes.md → docs/sources/reference/components/discovery/discovery.kubernetes.md

@@ -1,5 +1,7 @@
 ---
-canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.kubernetes/
+canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.kubernetes/
+aliases:
+  - ../discovery.kubernetes/ # /docs/alloy/latest/reference/components/discovery.kubernetes/
 description: Learn about discovery.kubernetes
 title: discovery.kubernetes
 ---
@@ -446,7 +448,7 @@ Replace the following:
 
 `discovery.kubernetes` has exports that can be consumed by the following components:
 
-- Components that consume [Targets](../../compatibility/#targets-consumers)
+- Components that consume [Targets](../../../compatibility/#targets-consumers)
 
 {{< admonition type="note" >}}
 Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.