From c955a01f18625b024f5eb5cd5fe176dc1b654ef0 Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Tue, 26 Sep 2023 07:22:31 -0700 Subject: [PATCH] Fix some bad links (#5301) --- docs/sources/_index.md | 8 ++++---- .../components/prometheus.exporter.agent.md | 2 +- .../components/remote.kubernetes.configmap.md | 16 ++++++++-------- .../components/remote.kubernetes.secret.md | 16 ++++++++-------- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 1f419426c286..eced09539a7e 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -20,7 +20,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]({{< relref "./flow" >}}), 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 %}} @@ -66,9 +66,9 @@ Grafana Agent can collect, transform, and send data to: * [Flow mode][] [variants]: {{< relref "./about.md" >}} -[Static mode]: {{< relref "./static/" >}} -[Static mode Kubernetes operator]: {{< relref "./operator/" >}} -[Flow mode]: {{< relref "./flow/" >}} +[Static mode]: {{< relref "./static" >}} +[Static mode Kubernetes operator]: {{< relref "./operator" >}} +[Flow mode]: {{< relref "./flow" >}} ## Supported platforms diff --git a/docs/sources/flow/reference/components/prometheus.exporter.agent.md b/docs/sources/flow/reference/components/prometheus.exporter.agent.md index 174fece7fa2c..8c8c7ca77f8e 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.agent.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.agent.md @@ -18,7 +18,7 @@ prometheus.exporter.agent "agent" { ## Exported fields -{{< docs/shared lookup="flow/reference/components/exporters-component-exports.md" source="agent" version="" >}} +{{< docs/shared lookup="flow/reference/components/exporter-component-exports.md" source="agent" version="" >}} ## Component health diff --git a/docs/sources/flow/reference/components/remote.kubernetes.configmap.md b/docs/sources/flow/reference/components/remote.kubernetes.configmap.md index 9120832b3984..8d7ff6bcfaa5 100644 --- a/docs/sources/flow/reference/components/remote.kubernetes.configmap.md +++ b/docs/sources/flow/reference/components/remote.kubernetes.configmap.md @@ -29,7 +29,7 @@ Name | Type | Description | Default | Required `poll_frequency` | `duration` | Frequency to poll the Kubernetes API. | `"1m"` | no `poll_timeout` | `duration` | Timeout when polling the Kubernetes API. | `"15s"` | no -When this component performs a poll operation, it requests the ConfigMap data from the Kubernetes API. +When this component performs a poll operation, it requests the ConfigMap data from the Kubernetes API. A poll is triggered by the following: * When the component first loads. @@ -87,19 +87,19 @@ Name | Type | Description | Default | Required ### basic_auth block -{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="" >}} ### authorization block -{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="" >}} ### oauth2 block -{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="" >}} ### tls_config block -{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="" >}} ## Exported fields @@ -108,9 +108,9 @@ The following fields are exported and can be referenced by other components: Name | Type | Description ---- | ---- | ----------- -`data` | `map(string)` | Data from the ConfigMap obtained from kubernetes. +`data` | `map(string)` | Data from the ConfigMap obtained from Kubernetes. -The `data` field contains a mapping from field names to values. +The `data` field contains a mapping from field names to values. ## Component health @@ -151,5 +151,5 @@ prometheus.remote_write "default" { ``` This example assumes that the Secret and ConfigMap have already been created, and that the appropriate field names -exist in their data. +exist in their data. diff --git a/docs/sources/flow/reference/components/remote.kubernetes.secret.md b/docs/sources/flow/reference/components/remote.kubernetes.secret.md index 09defa406c2f..64d75972ef11 100644 --- a/docs/sources/flow/reference/components/remote.kubernetes.secret.md +++ b/docs/sources/flow/reference/components/remote.kubernetes.secret.md @@ -29,7 +29,7 @@ Name | Type | Description | Default | Required `poll_frequency` | `duration` | Frequency to poll the Kubernetes API. | `"1m"` | no `poll_timeout` | `duration` | Timeout when polling the Kubernetes API. | `"15s"` | no -When this component performs a poll operation, it requests the Secret data from the Kubernetes API. +When this component performs a poll operation, it requests the Secret data from the Kubernetes API. A poll is triggered by the following: * When the component first loads. @@ -87,19 +87,19 @@ Name | Type | Description | Default | Required ### basic_auth block -{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="" >}} ### authorization block -{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="" >}} ### oauth2 block -{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="" >}} ### tls_config block -{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" >}} +{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="" >}} ## Exported fields @@ -108,9 +108,9 @@ The following fields are exported and can be referenced by other components: Name | Type | Description ---- | ---- | ----------- -`data` | `map(secret)` | Data from the secret obtained from kubernetes. +`data` | `map(secret)` | Data from the secret obtained from Kubernetes. -The `data` field contains a mapping from field names to values. +The `data` field contains a mapping from field names to values. If an individual key stored in `data` does not hold sensitive data, it can be converted into a string using [the `nonsensitive` function][nonsensitive]: @@ -163,4 +163,4 @@ prometheus.remote_write "default" { ``` This example assumes that the Secret and ConfigMap have already been created, and that the appropriate field names -exist in their data. \ No newline at end of file +exist in their data. \ No newline at end of file