From fb4d56f75156d72bfa3b87023e430a467feeace0 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 3 Oct 2023 09:46:56 +0100 Subject: [PATCH] Fix some build errors related to mounted content Primarily arising from Flow content not being mounted in Grafana Cloud. Some were typos or incorrect relative paths. Signed-off-by: Jack Baldry --- docs/sources/_index.md | 21 ++++++++++++--- docs/sources/about.md | 27 +++++++++++++------ docs/sources/operator/release-notes.md | 23 +++++++++------- .../configuration/create-config-file.md | 2 +- docs/sources/static/configuration/flags.md | 8 +++--- docs/sources/static/release-notes.md | 8 ++++-- .../set-up/install/install-agent-binary.md | 2 +- 7 files changed, 63 insertions(+), 28 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 659f0249f4ae..8afd3acff6b3 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -21,7 +21,7 @@ form programmable observability **pipelines** for telemetry collection, processing, and delivery. {{% admonition type="note" %}} -This page focuses mainly on [Flow mode]({{< relref "./flow" >}}), the Terraform-inspired variant of Grafana Agent. +This page focuses mainly on [Flow mode][], the Terraform-inspired variant of Grafana Agent. For information on other variants of Grafana Agent, refer to [Introduction to Grafana Agent]({{< relref "./about.md" >}}). {{% /admonition %}} @@ -56,8 +56,6 @@ Grafana Agent can collect, transform, and send data to: * **Batteries included**: Integrate with systems like MySQL, Kubernetes, and Apache to get telemetry that's immediately useful. -[UI]: {{< relref "./flow/monitoring/debugging.md#grafana-agent-flow-ui" >}} - ## Getting started * Choose a [variant][variants] of Grafana Agent to run. @@ -106,3 +104,20 @@ one minor release is moved. Patch and security releases may be created at any time. [Milestones]: https://github.com/grafana/agent/milestones + +{{% docs/reference %}} +[variants]: "/docs/agent/ -> /docs/agent//about" +[variants]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/about" + +[Static mode]: "/docs/agent/ -> /docs/agent//static" +[Static mode]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static" + +[Static mode Kubernetes operator]: "/docs/agent/ -> /docs/agent//operator" +[Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/operator" + +[Flow mode]: "/docs/agent/ -> /docs/agent//flow" +[Flow mode]: "/docs/grafana-cloud/ -> /docs/agent//flow" + +[UI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +[UI]: "/docs/grafana-cloud/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +{{% /docs/reference %}} diff --git a/docs/sources/about.md b/docs/sources/about.md index a02585b56ebc..f61cd5e7f51b 100644 --- a/docs/sources/about.md +++ b/docs/sources/about.md @@ -19,13 +19,20 @@ such as Prometheus and OpenTelemetry. Grafana Agent is available in three different variants: -* [Static mode][]: The default, original variant of Grafana Agent. -* [Static mode Kubernetes operator][]: Variant which manages agents running in Static mode. -* [Flow mode][]: The newer, more flexible re-imagining variant of Grafana Agent. +- [Static mode][]: The default, original variant of Grafana Agent. +- [Static mode Kubernetes operator][]: Variant which manages agents running in Static mode. +- [Flow mode][]: The newer, more flexible re-imagining variant of Grafana Agent. -[Static mode]: {{< relref "./static/" >}} -[Static mode Kubernetes operator]: {{< relref "./operator/" >}} -[Flow mode]: {{< relref "./flow/" >}} +{{% docs/reference %}} +[Static mode]: "/docs/agent/ -> /docs/agent//static" +[Static mode]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static" + +[Static mode Kubernetes operator]: "/docs/agent/ -> /docs/agent//operator" +[Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/operator" + +[Flow mode]: "/docs/agent/ -> /docs/agent//flow" +[Flow mode]: "/docs/grafana-cloud/ -> /docs/agent//flow" +{{% /docs/reference %}} ## Stability @@ -107,6 +114,10 @@ You should run Flow mode when: [BoringCrypto](https://pkg.go.dev/crypto/internal/boring) is an **EXPERIMENTAL** feature for building Grafana Agent binaries and images with BoringCrypto enabled. Builds and Docker images for Linux arm64/amd64 are made available. -[integrations]: {{< relref "./static/configuration/integrations/" >}} -[components]: {{< relref "./flow/reference/components/" >}} +{{% docs/reference %}} +[integrations]: "/docs/agent/ -> /docs/agent//static/configuration/integrations" +[integrations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static/configuration/integrations" +[components]: "/docs/agent/ -> /docs/agent//flow/reference/components" +[components]: "/docs/grafana-cloud/ -> /docs/agent//flow/reference/components" +{{% /docs/reference %}} diff --git a/docs/sources/operator/release-notes.md b/docs/sources/operator/release-notes.md index b83f3a50aab6..28eac0947108 100644 --- a/docs/sources/operator/release-notes.md +++ b/docs/sources/operator/release-notes.md @@ -19,16 +19,19 @@ The release notes provide information about deprecations and breaking changes in For a complete list of changes to Grafana Agent, with links to pull requests and related issues when available, refer to the [Changelog](https://github.com/grafana/agent/blob/main/CHANGELOG.md). -{{% admonition type="note" %}} -These release notes are specific to the Static mode Kubernetes Operator. -Other release notes for the different Grafana Agent variants are contained on separate pages: - -* [Static mode release notes][release-notes-static] -* [Flow mode release notes][release-notes-flow] - -[release-notes-static]: {{< relref "../static/release-notes.md" >}} -[release-notes-flow]: {{< relref "../flow/release-notes.md" >}} -{{% /admonition %}} +> **Note:** These release notes are specific to the Static mode Kubernetes Operator. +> Other release notes for the different Grafana Agent variants are contained on separate pages: +> +> - [Static mode release notes][release-notes-static] +> - [Flow mode release notes][release-notes-flow] + +{{% docs/reference %}} +[release-notes-static]: "/docs/agent/ -> /docs/agent//static/release-notes" +[release-notes-static]: "/docs/agent/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static/release-notes" + +[release-notes-flow]: "/docs/agent/ -> /docs/agent//flow/release-notes" +[release-notes-flow]: "/docs/grafana-cloud/ -> /docs/agent//flow/release-notes" +{{% /docs/reference %}} ## v0.33 diff --git a/docs/sources/static/configuration/create-config-file.md b/docs/sources/static/configuration/create-config-file.md index 98d8b7e62dc6..25e774a64d69 100644 --- a/docs/sources/static/configuration/create-config-file.md +++ b/docs/sources/static/configuration/create-config-file.md @@ -186,5 +186,5 @@ integrations: {{% docs/reference %}} [configure]: "/docs/agent/ -> /docs/agent//static/configuration" -[configure]: "/docs/grafana-cloud/ -> ./configuration" +[configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static/configuration" {{% /docs/reference %}} diff --git a/docs/sources/static/configuration/flags.md b/docs/sources/static/configuration/flags.md index 99e67288fac9..8d54ade73e73 100644 --- a/docs/sources/static/configuration/flags.md +++ b/docs/sources/static/configuration/flags.md @@ -146,9 +146,11 @@ YAML configuration when the `-server.http.tls-enabled` flag is used. {{% docs/reference %}} [retrieving]: "/docs/agent/ -> /docs/agent//static/configuration#remote-configuration-experimental" -[retrieving]: "/docs/grafana-cloud/ -> ./configuration#remote-configuration-experimental" +[retrieving]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static/configuration#remote-configuration-experimental" + [revamp]: "/docs/agent/ -> /docs/agent//static/configuration/integrations/integrations-next/" -[revamp]: "/docs/grafana-cloud/ -> ./integrations/integrations-next/" +[revamp]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static/configuration/integrations/integrations-next" + [management]: "/docs/agent/ -> /docs/agent//static/configuration/agent-management" -[management]: "/docs/grafana-cloud/ -> ./agent-management" +[management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static/configuration/agent-management" {{% /docs/reference %}} diff --git a/docs/sources/static/release-notes.md b/docs/sources/static/release-notes.md index 6cbf64156f07..f78df5ccde06 100644 --- a/docs/sources/static/release-notes.md +++ b/docs/sources/static/release-notes.md @@ -24,8 +24,12 @@ For a complete list of changes to Grafana Agent, with links to pull requests and {{% docs/reference %}} [release-notes-operator]: "/docs/agent/ -> /docs/agent//operator/release-notes" [release-notes-operator]: "/docs/grafana-cloud/ -> ../operator/release-notes" + [release-notes-flow]: "/docs/agent/ -> /docs/agent//flow/release-notes" -[release-notes-flow]: "/docs/grafana-cloud/ -> ../flow/release-notes" +[release-notes-flow]: "/docs/grafana-cloud/ -> /docs/agent//flow/release-notes" + +[Modules]: "/docs/agent/ -> /docs/agent//flow/concepts/modules" +[Modules]: "/docs/grafana-cloud/ -> /docs/agent//flow/concepts/modules" {{% /docs/reference %}} ## v0.37 @@ -140,7 +144,7 @@ See [Module and Auth Split Migration](https://github.com/prometheus/snmp_exporte ### Removal of Dynamic Configuration The experimental feature Dynamic Configuration has been removed. The use case of dynamic configuration will be replaced -with [Modules]({{< relref "../flow/concepts/modules" >}}) in Grafana Agent Flow. +with [Modules][] in Grafana Agent Flow. ### Breaking change: Removed and renamed tracing metrics diff --git a/docs/sources/static/set-up/install/install-agent-binary.md b/docs/sources/static/set-up/install/install-agent-binary.md index 8d53d4a7e5ae..fb679436b9c1 100644 --- a/docs/sources/static/set-up/install/install-agent-binary.md +++ b/docs/sources/static/set-up/install/install-agent-binary.md @@ -54,7 +54,7 @@ To download the Grafana Agent as a standalone binary, perform the following step [linux]: "/docs/agent/ -> /docs/agent//static/set-up/install/install-agent-linux" [linux]: "/docs/grafana-cloud/ -> ./install-agent-linux" [macos]: "/docs/agent/ -> /docs/agent//static/set-up/install/install-agent-macos" -[macos]: "/docs/grafana-cloud/ -> ./install-agent-mac-os" +[macos]: "/docs/grafana-cloud/ -> ./install-agent-macos" [windows]: "/docs/agent/ -> /docs/agent//static/set-up/install/install-agent-on-windows" [windows]: "/docs/grafana-cloud/ -> ./install-agent-on-windows" [start]: "/docs/agent/ -> /docs/agent//static/set-up/start-agent#standalone-binary"