Skip to content

Commit

Permalink
Update generated Compatible Components topic to remove relrefs (#6512)
Browse files Browse the repository at this point in the history
* Updated generation tooling and rebuilt topics

* Update to use relative URLs and regenerate

* Update the path for link in component topics
  • Loading branch information
clayton-cornell authored Feb 27, 2024
1 parent ad580f5 commit 62c1c85
Show file tree
Hide file tree
Showing 123 changed files with 362 additions and 351 deletions.
2 changes: 1 addition & 1 deletion docs/generator/compatible_components_page.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ func listOfLinksToComponents(components []string) string {
for _, namespace := range sortedNamespaces {
str += fmt.Sprintf("\n{{< collapse title=%q >}}\n", namespace)
for _, component := range groups[namespace] {
str += fmt.Sprintf("- [%[1]s]({{< relref \"../components/%[1]s.md\" >}})\n", component)
str += fmt.Sprintf("- [%[1]s](../components/%[1]s)\n", component)
}
str += "{{< /collapse >}}\n"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/generator/links_to_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func outputComponentsSection(name string, meta metadata.Metadata) string {
for _, outputDataType := range meta.AllTypesExported() {
if list := allComponentsThatAccept(outputDataType); len(list) > 0 {
section += fmt.Sprintf(
"- Components that consume [%s]({{< relref \"../compatibility/%s\" >}})\n",
"- Components that consume [%s](../../compatibility/%s)\n",
outputDataType.Name,
anchorFor(outputDataType.Name, "consumers"),
)
Expand All @@ -101,7 +101,7 @@ func acceptingComponentsSection(componentName string, meta metadata.Metadata) st
for _, acceptedDataType := range meta.AllTypesAccepted() {
if list := allComponentsThatExport(acceptedDataType); len(list) > 0 {
section += fmt.Sprintf(
"- Components that export [%s]({{< relref \"../compatibility/%s\" >}})\n",
"- Components that export [%s](../../compatibility/%s)\n",
acceptedDataType.Name,
anchorFor(acceptedDataType.Name, "exporters"),
)
Expand Down
363 changes: 187 additions & 176 deletions docs/sources/flow/reference/compatibility/_index.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Replace the following:

`discovery.azure` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
16 changes: 8 additions & 8 deletions docs/sources/flow/reference/components/discovery.consul.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ Name | Type | Description
The following blocks are supported inside the definition of
`discovery.consul`:

Hierarchy | Block | Description | Required
--------- | ----- | ----------- | --------
basic_auth | [basic_auth][] | Configure basic_auth for authenticating to the endpoint. | no
authorization | [authorization][] | Configure generic authorization to the endpoint. | no
oauth2 | [oauth2][] | Configure OAuth2 for authenticating to the endpoint. | no
oauth2 > tls_config | [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
tls_config | [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
Hierarchy | Block | Description | Required
--------------------|-------------------|----------------------------------------------------------|---------
basic_auth | [basic_auth][] | Configure basic_auth for authenticating to the endpoint. | no
authorization | [authorization][] | Configure generic authorization to the endpoint. | no
oauth2 | [oauth2][] | Configure OAuth2 for authenticating to the endpoint. | no
oauth2 > tls_config | [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
tls_config | [tls_config][] | Configure TLS settings for connecting to the endpoint. | no

The `>` symbol indicates deeper levels of nesting. For example,
`oauth2 > tls_config` refers to a `tls_config` block defined inside
Expand Down Expand Up @@ -180,7 +180,7 @@ Replace the following:

`discovery.consul` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Replace the following:

`discovery.consulagent` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Replace the following:

`discovery.digitalocean` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Replace the following:

`discovery.dns` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Replace the following:

`discovery.docker` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Replace the following:

`discovery.dockerswarm` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Replace the following:

`discovery.ec2` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.eureka.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Replace the following:

`discovery.eureka` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.file.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Replace the following:

`discovery.file` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.gce.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Replace the following:

`discovery.gce` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Replace the following:

`discovery.hetzner` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.http.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ discovery.http "dynamic_targets" {

`discovery.http` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.ionos.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Replace the following:

`discovery.ionos` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Replace the following:

`discovery.kubelet` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ Replace the following:

`discovery.kubernetes` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.kuma.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Replace the following:

`discovery.kuma` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Replace the following:

`discovery.lightsail` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.linode.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ prometheus.remote_write "demo" {

`discovery.linode` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Replace the following:

`discovery.marathon` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.nerve.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Replace the following:

`discovery.nerve` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.nomad.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Replace the following:

`discovery.nomad` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Replace the following:

`discovery.openstack` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Replace the following:

`discovery.ovhcloud` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/components/discovery.process.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,11 +201,11 @@ discovery.process "all" {

`discovery.process` can accept arguments from the following components:

- Components that export [Targets]({{< relref "../compatibility/#targets-exporters" >}})
- Components that export [Targets](../../compatibility/#targets-exporters)

`discovery.process` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Replace the following:

`discovery.puppetdb` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/components/discovery.relabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,11 @@ discovery.relabel "keep_backend_only" {

`discovery.relabel` can accept arguments from the following components:

- Components that export [Targets]({{< relref "../compatibility/#targets-exporters" >}})
- Components that export [Targets](../../compatibility/#targets-exporters)

`discovery.relabel` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Replace the following:

`discovery.scaleway` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ prometheus.remote_write "default" {

`discovery.serverset` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.triton.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Replace the following:

`discovery.triton` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/discovery.uyuni.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Replace the following:

`discovery.uyuni` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/components/faro.receiver.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,8 +274,8 @@ Replace the following:

`faro.receiver` can accept arguments from the following components:

- Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}})
- Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}})
- Components that export [Loki `LogsReceiver`](../../compatibility/#loki-logsreceiver-exporters)
- Components that export [OpenTelemetry `otelcol.Consumer`](../../compatibility/#opentelemetry-otelcolconsumer-exporters)


{{< admonition type="note" >}}
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/components/local.file_match.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,11 @@ Replace the following:

`local.file_match` can accept arguments from the following components:

- Components that export [Targets]({{< relref "../compatibility/#targets-exporters" >}})
- Components that export [Targets](../../compatibility/#targets-exporters)

`local.file_match` has exports that can be consumed by the following components:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})
- Components that consume [Targets](../../compatibility/#targets-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/loki.echo.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ loki.echo "example" { }

`loki.echo` has exports that can be consumed by the following components:

- Components that consume [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-consumers" >}})
- Components that consume [Loki `LogsReceiver`](../../compatibility/#loki-logsreceiver-consumers)

{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Expand Down
Loading

0 comments on commit 62c1c85

Please sign in to comment.