First step to change release life cycle info (#93)

* First step to change release life cycle info * Update shared link * Remove beta label and add public preview badge * Add missing beta shared element and remove extra aliases * Update beta references and remove redundant aliases * Fix bad metadata and remove redundant stability topic * Fix bad copy paste
grafana · Mar 27, 2024 · f3a27d7 · f3a27d7
1 parent 0a388b9
commit f3a27d7
Show file tree

Hide file tree

Showing 62 changed files with 84 additions and 207 deletions.
diff --git a/docs/sources/concepts/clustering.md b/docs/sources/concepts/clustering.md
@@ -58,10 +58,10 @@ Refer to component reference documentation to discover whether it supports clust
 You can use the {{< param "PRODUCT_NAME" >}} UI [clustering page][] to monitor your cluster status.
 Refer to [Debugging clustering issues][debugging] for additional troubleshooting information.
 
-[run]: ../../reference/cli/run/#clustering-beta
-[prometheus.scrape]: ../../reference/components/prometheus.scrape/#clustering-beta
-[pyroscope.scrape]: ../../reference/components/pyroscope.scrape/#clustering-beta
-[prometheus.operator.podmonitors]: ../../reference/components/prometheus.operator.podmonitors/#clustering-beta
-[prometheus.operator.servicemonitors]: ../../reference/components/prometheus.operator.servicemonitors/#clustering-beta
+[run]: ../../reference/cli/run/#clustering
+[prometheus.scrape]: ../../reference/components/prometheus.scrape/#clustering-block
+[pyroscope.scrape]: ../../reference/components/pyroscope.scrape/#clustering-block
+[prometheus.operator.podmonitors]: ../../reference/components/prometheus.operator.podmonitors/#clustering-block
+[prometheus.operator.servicemonitors]: ../../reference/components/prometheus.operator.servicemonitors/#clustering-block
 [clustering page]: ../../tasks/debug/#clustering-page
 [debugging]: ../../tasks/debug/#debugging-clustering-issues
diff --git a/docs/sources/reference/_index.md b/docs/sources/reference/_index.md
@@ -1,6 +1,4 @@
 ---
-aliases:
-- ./reference/
 canonical: https://grafana.com/docs/alloy/latest/reference/
 description: The reference-level documentaiton for Grafana Aloy
 menuTitle: Reference

diff --git a/docs/sources/reference/cli/_index.md b/docs/sources/reference/cli/_index.md
@@ -1,6 +1,4 @@
 ---
-aliases:
-- ./reference/cli/
 canonical: https://grafana.com/docs/alloy/latest/reference/cli/
 description: Learn about the Grafana Alloy command line interface
 menuTitle: Command-line interface

diff --git a/docs/sources/reference/cli/convert.md b/docs/sources/reference/cli/convert.md
@@ -1,17 +1,17 @@
 ---
-aliases:
-- ./reference/cli/convert/
 canonical: https://grafana.com/docs/alloy/latest/reference/cli/convert/
 description: Learn about the convert command
-labels:
-  stage: beta
 menuTitle: convert
 title: The convert command
 weight: 100
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # The convert command
 
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
+
 The `convert` command converts a supported configuration format to the {{< param "PRODUCT_NAME" >}} configuration format.
 
 ## Usage

diff --git a/docs/sources/reference/cli/fmt.md b/docs/sources/reference/cli/fmt.md
@@ -1,6 +1,4 @@
 ---
-aliases:
-- ./reference/cli/fmt/
 canonical: https://grafana.com/docs/alloy/latest/reference/cli/fmt/
 description: Learn about the fmt command
 menuTitle: fmt

diff --git a/docs/sources/reference/cli/run.md b/docs/sources/reference/cli/run.md
@@ -1,6 +1,4 @@
 ---
-aliases:
-- ./reference/cli/run/
 canonical: https://grafana.com/docs/alloy/latest/reference/cli/run/
 description: Learn about the run command
 menuTitle: run
@@ -128,7 +126,9 @@ Each {{< param "PRODUCT_NAME" >}} then transitions to the terminating state when
 
 The current state of a clustered {{< param "PRODUCT_NAME" >}} is shown on the clustering page in the [UI][].
 
-## Configuration conversion (beta)
+## Configuration conversion
+
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 When you use the `--config.format` command-line argument with a value other than `alloy`, {{< param "PRODUCT_NAME" >}} converts the configuration file from the source format to {{< param "PRODUCT_NAME" >}} and immediately starts running with the new configuration.
 This conversion uses the converter API described in the [alloy convert][] docs.

diff --git a/docs/sources/reference/cli/tools.md b/docs/sources/reference/cli/tools.md
@@ -1,6 +1,4 @@
 ---
-aliases:
-- ./reference/cli/tools/
 canonical: https://grafana.com/docs/aalloyent/latest/reference/cli/tools/
 description: Learn about the tools command
 menuTitle: tools

diff --git a/docs/sources/reference/compatibility/_index.md b/docs/sources/reference/compatibility/_index.md
@@ -1,6 +1,4 @@
 ---
-aliases:
-- ./reference/compatibility/
 canonical: https://grafana.com/docs/alloy/latest/reference/compatibility/
 description: Learn about which components are compatible with each other in Grafana Alloy
 title: Compatible components

diff --git a/docs/sources/reference/components/discovery.kubelet.md b/docs/sources/reference/components/discovery.kubelet.md
@@ -1,13 +1,15 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.kubelet/
 description: Learn about discovery.kubelet
-labels:
-  stage: beta
 title: discovery.kubelet
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # discovery.kubelet
 
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
+
 `discovery.kubelet` discovers Kubernetes pods running on the specified Kubelet and exposes them as scrape targets.
 
 ## Usage

diff --git a/docs/sources/reference/components/discovery.process.md b/docs/sources/reference/components/discovery.process.md
@@ -2,13 +2,13 @@
 canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.process/
 description: Learn about discovery.process
 title: discovery.process
-labels:
-  stage: beta
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # discovery.process
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `discovery.process` discovers processes running on the local Linux OS.
 

diff --git a/docs/sources/reference/components/loki.echo.md b/docs/sources/reference/components/loki.echo.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.echo/
 description: Learn about loki.echo
-labels:
-  stage: beta
 title: loki.echo
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # loki.echo
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `loki.echo` receives log entries from other `loki` components and prints them to the process' standard output (stdout).
 

diff --git a/docs/sources/reference/components/loki.rules.kubernetes.md b/docs/sources/reference/components/loki.rules.kubernetes.md
@@ -1,4 +1,5 @@
 ---
+canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.rules.kubernetes/
 title: loki.rules.kubernetes
 labels:
   stage: experimental

diff --git a/docs/sources/reference/components/mimir.rules.kubernetes.md b/docs/sources/reference/components/mimir.rules.kubernetes.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/mimir.rules.kubernetes/
 description: Learn about mimir.rules.kubernetes
-labels:
-  stage: beta
 title: mimir.rules.kubernetes
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # mimir.rules.kubernetes
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `mimir.rules.kubernetes` discovers `PrometheusRule` Kubernetes resources and
 loads them into a Mimir instance.

diff --git a/docs/sources/reference/components/otelcol.exporter.loadbalancing.md b/docs/sources/reference/components/otelcol.exporter.loadbalancing.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.exporter.loadbalancing/
 description: Learn about otelcol.exporter.loadbalancing
-labels:
-  stage: beta
 title: otelcol.exporter.loadbalancing
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # otelcol.exporter.loadbalancing
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 <!-- Include a picture of the LB architecture? -->
 

diff --git a/docs/sources/reference/components/otelcol.processor.discovery.md b/docs/sources/reference/components/otelcol.processor.discovery.md
@@ -1,5 +1,4 @@
 ---
-aliases:
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.discovery/
 description: Learn about otelcol.processor.discovery
 title: otelcol.processor.discovery

diff --git a/docs/sources/reference/components/otelcol.processor.resourcedetection.md b/docs/sources/reference/components/otelcol.processor.resourcedetection.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.resourcedetection/
-labels:
-  stage: beta
 title: otelcol.processor.resourcedetection
 description: Learn about otelcol.processor.resourcedetection
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # otelcol.processor.resourcedetection
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<AGENT VERSION>" >}}
 
 `otelcol.processor.resourcedetection` detects resource information from the host in a format that conforms to the [OpenTelemetry resource semantic conventions][], and appends or overrides the resource values in the telemetry data with this information.
 

diff --git a/docs/sources/reference/components/otelcol.processor.tail_sampling.md b/docs/sources/reference/components/otelcol.processor.tail_sampling.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.tail_sampling/
 description: Learn about otelcol.processor.tail_sampling
-labels:
-  stage: beta
 title: otelcol.processor.tail_sampling
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # otelcol.processor.tail_sampling
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `otelcol.processor.tail_sampling` samples traces based on a set of defined
 policies. All spans for a given trace *must* be received by the same collector

diff --git a/docs/sources/reference/components/otelcol.receiver.loki.md b/docs/sources/reference/components/otelcol.receiver.loki.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.loki/
 description: Learn about otelcol.receiver.loki
-labels:
-  stage: beta
 title: otelcol.receiver.loki
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # otelcol.receiver.loki
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `otelcol.receiver.loki` receives Loki log entries, converts them to the
 OpenTelemetry logs format, and forwards them to other `otelcol.*` components.

diff --git a/docs/sources/reference/components/otelcol.receiver.prometheus.md b/docs/sources/reference/components/otelcol.receiver.prometheus.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.prometheus/
 description: Learn about otelcol.receiver.prometheus
-labels:
-  stage: beta
 title: otelcol.receiver.prometheus
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # otelcol.receiver.prometheus
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `otelcol.receiver.prometheus` receives Prometheus metrics, converts them to the
 OpenTelemetry metrics format, and forwards them to other `otelcol.*`

diff --git a/docs/sources/reference/components/prometheus.exporter.postgres.md b/docs/sources/reference/components/prometheus.exporter.postgres.md
@@ -1,11 +1,11 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.exporter.postgres/
 description: Learn about prometheus.exporter.postgres
-labels:
-  stage: beta
 title: prometheus.exporter.postgres
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # prometheus.exporter.postgres
 
 The `prometheus.exporter.postgres` component embeds

diff --git a/docs/sources/reference/components/prometheus.operator.podmonitors.md b/docs/sources/reference/components/prometheus.operator.podmonitors.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.operator.podmonitors/
 description: Learn about prometheus.operator.podmonitors
-labels:
-  stage: beta
 title: prometheus.operator.podmonitors
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # prometheus.operator.podmonitors
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `prometheus.operator.podmonitors` discovers [PodMonitor](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PodMonitor) resources in your kubernetes cluster and scrapes the targets they reference. This component performs three main functions:
 
@@ -68,7 +68,7 @@ inside a `client` block.
 [match_expression]: #match_expression-block
 [rule]: #rule-block
 [scrape]: #scrape-block
-[clustering]: #clustering-beta
+[clustering]: #clustering-block
 
 ### client block
 
@@ -158,7 +158,7 @@ The `operator` argument must be one of the following strings:
 
 If there are multiple `match_expressions` blocks inside of a `selector` block, they are combined together with AND clauses.
 
-### clustering (beta)
+### clustering block
 
 Name | Type | Description | Default | Required
 ---- | ---- | ----------- | ------- | --------

diff --git a/docs/sources/reference/components/prometheus.operator.probes.md b/docs/sources/reference/components/prometheus.operator.probes.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.operator.probes/
 description: Learn about prometheus.operator.probes
-labels:
-  stage: beta
 title: prometheus.operator.probes
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # prometheus.operator.probes
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `prometheus.operator.probes` discovers [Probe](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.Probe) resources in your Kubernetes cluster and scrapes the targets they reference.
  This component performs three main functions:
@@ -160,7 +160,7 @@ The `operator` argument must be one of the following strings:
 
 If there are multiple `match_expressions` blocks inside of a `selector` block, they are combined together with AND clauses.
 
-### clustering (experimental)
+### clustering block
 
 Name | Type | Description | Default | Required
 ---- | ---- | ----------- | ------- | --------
@@ -188,7 +188,7 @@ fully consistent like hashmod sharding is).
 If {{< param "PRODUCT_NAME" >}} is _not_ running in clustered mode, then the block is a no-op, and
 `prometheus.operator.probes` scrapes every target it receives in its arguments.
 
-[clustered mode]: ../../cli/run/#clustering-beta
+[clustered mode]: ../../cli/run/#clustering
 
 ## Exported fields
 

diff --git a/docs/sources/reference/components/prometheus.operator.servicemonitors.md b/docs/sources/reference/components/prometheus.operator.servicemonitors.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.operator.servicemonitors/
 description: Learn about prometheus.operator.servicemonitors
-labels:
-  stage: beta
 title: prometheus.operator.servicemonitors
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # prometheus.operator.servicemonitors
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `prometheus.operator.servicemonitors` discovers [ServiceMonitor](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.ServiceMonitor) resources in your kubernetes cluster and scrapes the targets they reference. This component performs three main functions:
 

diff --git a/docs/sources/reference/components/pyroscope.ebpf.md b/docs/sources/reference/components/pyroscope.ebpf.md
@@ -1,14 +1,14 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/pyroscope.ebpf/
 description: Learn about pyroscope.ebpf
-labels:
-  stage: beta
 title: pyroscope.ebpf
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # pyroscope.ebpf
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `pyroscope.ebpf` configures an ebpf profiling job for the current host. The collected performance profiles are forwarded
 to the list of receivers passed in `forward_to`.

diff --git a/docs/sources/reference/components/pyroscope.java.md b/docs/sources/reference/components/pyroscope.java.md
@@ -6,7 +6,7 @@ title: pyroscope.java
 
 # pyroscope.java
 
-{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
 `pyroscope.java` continuously profiles Java processes running on the local Linux OS
 using [async-profiler](https://github.com/async-profiler/async-profiler).