Skip to content

Commit 4257ca3

Browse files
jdbaldryjdbaldry
authored
[release-v0.40] Replace docs/reference shortcode with ref URIs (#6889)
* Replace all docs/reference use with ref URIs Signed-off-by: Jack Baldry <[email protected]> * Fix missing parens Signed-off-by: Jack Baldry <[email protected]> (cherry picked from commit 7b41d2a) Signed-off-by: Jack Baldry <[email protected]> --------- Signed-off-by: Jack Baldry <[email protected]>
1 parent e729f14 commit 4257ca3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1516
-905
lines changed

‎docs/sources/_index.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,32 @@ weight: 350
1111
cascade:
1212
AGENT_RELEASE: v0.40.5
1313
OTEL_VERSION: v0.87.0
14+
refs:
15+
variants:
16+
- pattern: /docs/agent/
17+
destination: /docs/agent/<AGENT_VERSION>/about/
18+
- pattern: /docs/grafana-cloud/
19+
destination: /docs/grafana-cloud/send-data/agent/about/
20+
static-mode:
21+
- pattern: /docs/agent/
22+
destination: /docs/agent/<AGENT_VERSION>/static/
23+
- pattern: /docs/grafana-cloud/
24+
destination: /docs/grafana-cloud/send-data/agent/static/
25+
static-mode-kubernetes-operator:
26+
- pattern: /docs/agent/
27+
destination: /docs/agent/<AGENT_VERSION>/operator/
28+
- pattern: /docs/grafana-cloud/
29+
destination: /docs/grafana-cloud/send-data/agent/operator/
30+
flow-mode:
31+
- pattern: /docs/agent/
32+
destination: /docs/agent/<AGENT_VERSION>/flow/
33+
- pattern: /docs/grafana-cloud/
34+
destination: /docs/agent/<AGENT_VERSION>/flow/
35+
ui:
36+
- pattern: /docs/agent/
37+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/debug/#grafana-agent-flow-ui
38+
- pattern: /docs/grafana-cloud/
39+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/debug/#grafana-agent-flow-ui
1440
---
1541

1642
# Grafana Agent
@@ -55,17 +81,17 @@ Grafana Agent can collect, transform, and send data to:
5581
* **Battle-tested**: Grafana Agent extends the existing battle-tested code from
5682
the Prometheus and OpenTelemetry Collector projects.
5783
* **Powerful**: Write programmable pipelines with ease, and debug them using a
58-
[built-in UI][UI].
84+
[built-in UI](ref:ui).
5985
* **Batteries included**: Integrate with systems like MySQL, Kubernetes, and
6086
Apache to get telemetry that's immediately useful.
6187

6288
## Getting started
6389

64-
* Choose a [variant][variants] of Grafana Agent to run.
90+
* Choose a [variant](ref:variants) of Grafana Agent to run.
6591
* Refer to the documentation for the variant to use:
66-
* [Static mode][]
67-
* [Static mode Kubernetes operator][]
68-
* [Flow mode][]
92+
* [Static mode](ref:static-mode)
93+
* [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator)
94+
* [Flow mode](ref:flow-mode)
6995

7096
## Supported platforms
7197

@@ -101,19 +127,3 @@ one minor release is moved.
101127

102128
Patch and security releases may be created at any time.
103129

104-
{{% docs/reference %}}
105-
[variants]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/about"
106-
[variants]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/about"
107-
108-
[Static mode]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static"
109-
[Static mode]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static"
110-
111-
[Static mode Kubernetes operator]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/operator"
112-
[Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/operator"
113-
114-
[Flow mode]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow"
115-
[Flow mode]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow"
116-
117-
[UI]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
118-
[UI]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
119-
{{% /docs/reference %}}

‎docs/sources/_index.md.t

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,32 @@ weight: 350
1111
cascade:
1212
AGENT_RELEASE: $AGENT_VERSION
1313
OTEL_VERSION: v0.87.0
14+
refs:
15+
variants:
16+
- pattern: /docs/agent/
17+
destination: /docs/agent/<AGENT_VERSION>/about/
18+
- pattern: /docs/grafana-cloud/
19+
destination: /docs/grafana-cloud/send-data/agent/about/
20+
static-mode:
21+
- pattern: /docs/agent/
22+
destination: /docs/agent/<AGENT_VERSION>/static/
23+
- pattern: /docs/grafana-cloud/
24+
destination: /docs/grafana-cloud/send-data/agent/static/
25+
static-mode-kubernetes-operator:
26+
- pattern: /docs/agent/
27+
destination: /docs/agent/<AGENT_VERSION>/operator/
28+
- pattern: /docs/grafana-cloud/
29+
destination: /docs/grafana-cloud/send-data/agent/operator/
30+
flow-mode:
31+
- pattern: /docs/agent/
32+
destination: /docs/agent/<AGENT_VERSION>/flow/
33+
- pattern: /docs/grafana-cloud/
34+
destination: /docs/agent/<AGENT_VERSION>/flow/
35+
ui:
36+
- pattern: /docs/agent/
37+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/debug/#grafana-agent-flow-ui
38+
- pattern: /docs/grafana-cloud/
39+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/debug/#grafana-agent-flow-ui
1440
---
1541

1642
# Grafana Agent
@@ -55,17 +81,17 @@ Grafana Agent can collect, transform, and send data to:
5581
* **Battle-tested**: Grafana Agent extends the existing battle-tested code from
5682
the Prometheus and OpenTelemetry Collector projects.
5783
* **Powerful**: Write programmable pipelines with ease, and debug them using a
58-
[built-in UI][UI].
84+
[built-in UI](ref:ui).
5985
* **Batteries included**: Integrate with systems like MySQL, Kubernetes, and
6086
Apache to get telemetry that's immediately useful.
6187

6288
## Getting started
6389

64-
* Choose a [variant][variants] of Grafana Agent to run.
90+
* Choose a [variant](ref:variants) of Grafana Agent to run.
6591
* Refer to the documentation for the variant to use:
66-
* [Static mode][]
67-
* [Static mode Kubernetes operator][]
68-
* [Flow mode][]
92+
* [Static mode](ref:static-mode)
93+
* [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator)
94+
* [Flow mode](ref:flow-mode)
6995

7096
## Supported platforms
7197

@@ -101,19 +127,3 @@ one minor release is moved.
101127

102128
Patch and security releases may be created at any time.
103129

104-
{{% docs/reference %}}
105-
[variants]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/about"
106-
[variants]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/about"
107-
108-
[Static mode]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static"
109-
[Static mode]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static"
110-
111-
[Static mode Kubernetes operator]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/operator"
112-
[Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/operator"
113-
114-
[Flow mode]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow"
115-
[Flow mode]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow"
116-
117-
[UI]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
118-
[UI]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
119-
{{% /docs/reference %}}

‎docs/sources/about.md

Lines changed: 69 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,62 @@ description: Grafana Agent is a flexible, performant, vendor-neutral, telemetry
1010
menuTitle: Introduction
1111
title: Introduction to Grafana Agent
1212
weight: 100
13+
refs:
14+
static-mode-kubernetes-operator:
15+
- pattern: /docs/agent/
16+
destination: /docs/agent/<AGENT_VERSION>/operator/
17+
- pattern: /docs/grafana-cloud/
18+
destination: /docs/grafana-cloud/send-data/agent/operator/
19+
components:
20+
- pattern: /docs/agent/
21+
destination: /docs/agent/<AGENT_VERSION>/flow/reference/components/
22+
- pattern: /docs/grafana-cloud/
23+
destination: /docs/agent/<AGENT_VERSION>/flow/reference/components/
24+
flow-mode:
25+
- pattern: /docs/agent/
26+
destination: /docs/agent/<AGENT_VERSION>/flow/
27+
- pattern: /docs/grafana-cloud/
28+
destination: /docs/agent/<AGENT_VERSION>/flow/
29+
loki:
30+
- pattern: /docs/agent/
31+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/migrate/from-promtail/
32+
- pattern: /docs/grafana-cloud/
33+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/migrate/from-promtail/
34+
rules:
35+
- pattern: /docs/agent/
36+
destination: /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes/
37+
- pattern: /docs/grafana-cloud/
38+
destination: /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes/
39+
vault:
40+
- pattern: /docs/agent/
41+
destination: /docs/agent/<AGENT_VERSION>/flow/reference/components/remote.vault/
42+
- pattern: /docs/grafana-cloud/
43+
destination: /docs/agent/<AGENT_VERSION>/flow/reference/components/remote.vault/
44+
otel:
45+
- pattern: /docs/agent/
46+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/collect-opentelemetry-data/
47+
- pattern: /docs/grafana-cloud/
48+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/collect-opentelemetry-data/
49+
integrations:
50+
- pattern: /docs/agent/
51+
destination: /docs/agent/<AGENT_VERSION>/static/configuration/integrations/
52+
- pattern: /docs/grafana-cloud/
53+
destination: /docs/grafana-cloud/send-data/agent/static/configuration/integrations/
54+
static-mode:
55+
- pattern: /docs/agent/
56+
destination: /docs/agent/<AGENT_VERSION>/static/
57+
- pattern: /docs/grafana-cloud/
58+
destination: /docs/grafana-cloud/send-data/agent/static/
59+
prometheus:
60+
- pattern: /docs/agent/
61+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/collect-prometheus-metrics/
62+
- pattern: /docs/grafana-cloud/
63+
destination: /docs/agent/<AGENT_VERSION>/flow/tasks/collect-prometheus-metrics/
64+
clustering:
65+
- pattern: /docs/agent/
66+
destination: /docs/agent/<AGENT_VERSION>/flow/concepts/clustering//
67+
- pattern: /docs/grafana-cloud/
68+
destination: /docs/agent/<AGENT_VERSION>/flow/concepts/clustering//
1369
---
1470

1571
# Introduction to Grafana Agent
@@ -18,30 +74,10 @@ Grafana Agent is a flexible, high performance, vendor-neutral telemetry collecto
1874

1975
Grafana Agent is available in three different variants:
2076

21-
- [Static mode][]: The original Grafana Agent.
22-
- [Static mode Kubernetes operator][]: The Kubernetes operator for Static mode.
23-
- [Flow mode][]: The new, component-based Grafana Agent.
24-
25-
{{% docs/reference %}}
26-
[Static mode]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static"
27-
[Static mode]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static"
28-
[Static mode Kubernetes operator]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/operator"
29-
[Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/operator"
30-
[Flow mode]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow"
31-
[Flow mode]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow"
32-
[Prometheus]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-prometheus-metrics.md"
33-
[Prometheus]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-prometheus-metrics.md"
34-
[OTel]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-opentelemetry-data.md"
35-
[OTel]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-opentelemetry-data.md"
36-
[Loki]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/migrate/from-promtail.md"
37-
[Loki]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/migrate/from-promtail.md"
38-
[clustering]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering/_index.md"
39-
[clustering]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering/_index.md"
40-
[rules]: "/docs/agent/ -> /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes.md"
41-
[rules]: "/docs/grafana-cloud/ -> /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes.md"
42-
[vault]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/remote.vault.md"
43-
[vault]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/remote.vault.md"
44-
{{% /docs/reference %}}
77+
- [Static mode](ref:static-mode): The original Grafana Agent.
78+
- [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator): The Kubernetes operator for Static mode.
79+
- [Flow mode](ref:flow-mode): The new, component-based Grafana Agent.
80+
4581

4682
[Pyroscope]: https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent/go_pull
4783
[helm chart]: https://grafana.com/docs/grafana-cloud/monitor-infrastructure/kubernetes-monitoring/configuration/config-k8s-helmchart
@@ -69,19 +105,19 @@ Each variant of Grafana Agent provides a different level of functionality. The f
69105

70106
| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
71107
|--------------|--------------------------|---------------------------|------------------------|-------------------------|-----------------------|
72-
| **Metrics** | [Prometheus][], [OTel][] | Prometheus | Prometheus | OTel | Prometheus |
73-
| **Logs** | [Loki][], [OTel][] | Loki | Loki | OTel | No |
74-
| **Traces** | [OTel][] | OTel | OTel | OTel | No |
108+
| **Metrics** | [Prometheus](ref:prometheus), [OTel](ref:otel) | Prometheus | Prometheus | OTel | Prometheus |
109+
| **Logs** | [Loki](ref:loki), [OTel](ref:otel) | Loki | Loki | OTel | No |
110+
| **Traces** | [OTel](ref:otel) | OTel | OTel | OTel | No |
75111
| **Profiles** | [Pyroscope][] | No | No | Planned | No |
76112

77113
#### **OSS features**
78114

79115
| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
80116
|--------------------------|-------------------------|---------------------------|------------------------|-------------------------|-----------------------|
81117
| **Kubernetes native** | [Yes][helm chart] | No | Yes | Yes | No |
82-
| **Clustering** | [Yes][clustering] | No | No | No | No |
83-
| **Prometheus rules** | [Yes][rules] | No | No | No | No |
84-
| **Native Vault support** | [Yes][vault] | No | No | No | No |
118+
| **Clustering** | [Yes](ref:clustering) | No | No | No | No |
119+
| **Prometheus rules** | [Yes](ref:rules) | No | No | No | No |
120+
| **Native Vault support** | [Yes](ref:vault) | No | No | No | No |
85121

86122
#### Grafana Cloud solutions
87123

@@ -94,7 +130,7 @@ Each variant of Grafana Agent provides a different level of functionality. The f
94130

95131
### Static mode
96132

97-
[Static mode][] is the original variant of Grafana Agent, introduced on March 3, 2020.
133+
[Static mode](ref:static-mode) is the original variant of Grafana Agent, introduced on March 3, 2020.
98134
Static mode is the most mature variant of Grafana Agent.
99135

100136
You should run Static mode when:
@@ -110,7 +146,7 @@ Grafana Agent version 0.37 and newer provides Prometheus Operator compatibility
110146
You should use Grafana Agent Flow mode for all new Grafana Agent deployments.
111147
{{< /admonition >}}
112148

113-
The [Static mode Kubernetes operator][] is a variant of Grafana Agent introduced on June 17, 2021. It's currently in beta.
149+
The [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator) is a variant of Grafana Agent introduced on June 17, 2021. It's currently in beta.
114150

115151
The Static mode Kubernetes operator provides compatibility with Prometheus Operator,
116152
allowing static mode to support resources from Prometheus Operator, such as ServiceMonitors, PodMonitors, and Probes.
@@ -123,7 +159,7 @@ You should run the Static mode Kubernetes operator when:
123159

124160
### Flow mode
125161

126-
[Flow mode][] is a stable variant of Grafana Agent, introduced on September 29, 2022.
162+
[Flow mode](ref:flow-mode) is a stable variant of Grafana Agent, introduced on September 29, 2022.
127163

128164
Grafana Agent Flow mode focuses on vendor neutrality, ease-of-use,
129165
improved debugging, and ability to adapt to the needs of power users by adopting a configuration-as-code model.
@@ -147,10 +183,3 @@ You should run Flow mode when:
147183
[BoringCrypto](https://pkg.go.dev/crypto/internal/boring) is an **EXPERIMENTAL** feature for building Grafana Agent
148184
binaries and images with BoringCrypto enabled. Builds and Docker images for Linux arm64/amd64 are made available.
149185

150-
{{% docs/reference %}}
151-
[integrations]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static/configuration/integrations"
152-
[integrations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/configuration/integrations"
153-
154-
[components]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components"
155-
[components]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components"
156-
{{% /docs/reference %}}

‎docs/sources/data-collection.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,25 @@ description: Grafana Agent data collection
1010
menuTitle: Data collection
1111
title: Grafana Agent data collection
1212
weight: 500
13+
refs:
14+
command-line-flag:
15+
- pattern: /docs/agent/
16+
destination: /docs/agent/<AGENT_VERSION>/flow/reference/cli/run/
17+
- pattern: /docs/grafana-cloud/
18+
destination: /docs/agent/<AGENT_VERSION>/flow/reference/cli/run/
19+
components:
20+
- pattern: /docs/agent/
21+
destination: /docs/agent/<AGENT_VERSION>/flow/concepts/components/
22+
- pattern: /docs/grafana-cloud/
23+
destination: /docs/agent/<AGENT_VERSION>/flow/reference/cli/run/
24+
static:
25+
- pattern: /docs/agent/
26+
destination: /docs/agent/<AGENT_VERSION>/static/
27+
flow:
28+
- pattern: /docs/agent/
29+
destination: /docs/agent/<AGENT_VERSION>/flow/
30+
- pattern: /docs/grafana-cloud/
31+
destination: /docs/agent/<AGENT_VERSION>/flow/
1332
---
1433

1534
# Grafana Agent Data collection
@@ -27,24 +46,14 @@ The usage information includes the following details:
2746
* Version of running Grafana Agent.
2847
* Operating system Grafana Agent is running on.
2948
* System architecture Grafana Agent is running on.
30-
* List of enabled feature flags ([Static] mode only).
31-
* List of enabled integrations ([Static] mode only).
32-
* List of enabled [components][] ([Flow] mode only).
49+
* List of enabled feature flags ([Static](ref:static) mode only).
50+
* List of enabled integrations ([Static](ref:static) mode only).
51+
* List of enabled [components](ref:components) ([Flow](ref:flow) mode only).
3352
* Method used to deploy Grafana Agent, for example Docker, Helm, RPM, or Operator.
3453

3554
This list may change over time. All newly reported data is documented in the CHANGELOG.
3655

3756
## Opt-out of data collection
3857

39-
You can use the `-disable-reporting` [command line flag][] to disable the reporting and opt-out of the data collection.
40-
41-
{{% docs/reference %}}
42-
[command line flag]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/cli/run.md"
43-
[command line flag]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/reference/cli/run.md"
44-
[components]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/components.md"
45-
[components]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/reference/cli/run.md"
46-
[Static]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static"
47-
[Static]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static
48-
[Flow]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow"
49-
[Flow]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow"
50-
{{% /docs/reference %}}
58+
You can use the `-disable-reporting` [command line flag](ref:command-line-flag) to disable the reporting and opt-out of the data collection.
59+

0 commit comments

Comments
 (0)