Skip to content

Commit

Permalink
Fix some bad links (#5301)
Browse files Browse the repository at this point in the history
  • Loading branch information
clayton-cornell authored Sep 26, 2023
1 parent 32ba6dc commit c955a01
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ prometheus.exporter.agent "agent" {

## Exported fields

{{< docs/shared lookup="flow/reference/components/exporters-component-exports.md" source="agent" version="<AGENT VERSION>" >}}
{{< docs/shared lookup="flow/reference/components/exporter-component-exports.md" source="agent" version="<AGENT VERSION>" >}}

## Component health

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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="<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="<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="<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="<AGENT VERSION>" >}}


## Exported fields
Expand All @@ -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

Expand Down Expand Up @@ -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.

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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="<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="<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="<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="<AGENT VERSION>" >}}


## Exported fields
Expand All @@ -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]:
Expand Down Expand Up @@ -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.
exist in their data.

0 comments on commit c955a01

Please sign in to comment.