Skip to content

Commit fc462b5

Browse files
authored
[v2.7.x] Remove relref shortcodes (#4821)
* relref replace - tempo * fix manifest link
1 parent cbd7a6d commit fc462b5

Some content is hidden

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

43 files changed

+156
-157
lines changed

docs/sources/tempo/configuration/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The Tempo configuration options include:
5252
- [Usage-report](#usage-report)
5353
- [Cache](#cache)
5454

55-
Additionally, you can review [TLS]({{< relref "./network/tls" >}}) to configure the cluster components to communicate over TLS, or receive traces over TLS.
55+
Additionally, you can review [TLS](network/tls/) to configure the cluster components to communicate over TLS, or receive traces over TLS.
5656

5757
## Use environment variables in the configuration
5858

@@ -356,7 +356,7 @@ ingester:
356356
For more information on configuration options, refer to [this file](https://github.com/grafana/tempo/blob/main/modules/generator/config.go).
357357

358358
The metrics-generator processes spans and write metrics using the Prometheus remote write protocol.
359-
For more information on the metrics-generator, refer to the [Metrics-generator documentation]({{< relref "../metrics-generator" >}}).
359+
For more information on the metrics-generator, refer to the [Metrics-generator documentation](../metrics-generator/).
360360

361361
Metrics-generator processors are disabled by default. To enable it for a specific tenant, set `metrics_generator.processors` in the [overrides](#overrides) section.
362362

@@ -970,10 +970,10 @@ The storage block configures TempoDB.
970970
The following example shows common options.
971971
For further platform-specific information, refer to the following:
972972
973-
* [GCS]({{< relref "./hosted-storage/gcs" >}})
974-
* [S3]({{< relref "./hosted-storage/s3" >}})
975-
* [Azure]({{< relref "./hosted-storage/azure" >}})
976-
* [Parquet]({{< relref "./parquet" >}})
973+
* [GCS](hosted-storage/gcs/)
974+
* [S3](hosted-storage/s3/)
975+
* [Azure](hosted-storage/azure/)
976+
* [Parquet](parquet/)
977977
978978
```yaml
979979
# Storage configuration for traces

docs/sources/tempo/configuration/grafana-agent/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,22 +119,22 @@ Refer to the `scrape_configs` block in the [configuration reference](/docs/agent
119119

120120
Automatic logging writes well formatted log lines to help with trace discovery.
121121

122-
For a closer look into the feature, visit [Automatic logging]({{< relref "./automatic-logging" >}}).
122+
For a closer look into the feature, visit [Automatic logging](automatic-logging/).
123123

124124
#### Tail-based sampling
125125

126126
The Agent implements tail-based sampling for distributed tracing systems and multi-instance Agent deployments.
127127
With this feature, sampling decisions can be made based on data from a trace, rather than exclusively with probabilistic methods.
128128

129-
For a detailed description, go to [Tail-based sampling]({{< relref "./tail-based-sampling" >}}).
129+
For a detailed description, go to [Tail-based sampling](tail-based-sampling/).
130130

131131
For additional information, refer to the blog post, [An introduction to trace sampling with Grafana Tempo and Grafana Agent](/blog/2022/05/11/an-introduction-to-trace-sampling-with-grafana-tempo-and-grafana-agent).
132132

133133
#### Generating metrics from spans
134134

135135
The Agent can take advantage of the span data flowing through the pipeline to generate Prometheus metrics.
136136

137-
Go to [Span metrics]({{< relref "./span-metrics" >}}) for a more detailed explanation of the feature.
137+
Go to [Span metrics](span-metrics/) for a more detailed explanation of the feature.
138138

139139
#### Service graph metrics
140140

@@ -144,7 +144,7 @@ This service graphs processor builds a map of services by analyzing traces, with
144144
Edges are spans with a parent-child relationship, that represent a jump, such as a request, between two services.
145145
The amount of requests and their duration are recorded as metrics, which are used to represent the graph.
146146

147-
To read more about this processor, go to its [section]({{< relref "./service-graphs" >}}).
147+
To read more about this processor, go to its [section](service-graphs/).
148148

149149
### Exporting spans
150150

docs/sources/tempo/configuration/grafana-agent/service-graphs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ and the connections and dependencies between its components.
1717

1818
The same service graph metrics can also be generated by Tempo.
1919
This is more efficient and recommended for larger installations.
20-
For a deep look into service graphs, visit [this section]({{< relref "../../metrics-generator/service_graphs" >}}).
20+
For a deep look into service graphs, visit [this section](../../../metrics-generator/service_graphs/).
2121

2222
Service graphs are also used in the application performance management dashboard.
23-
For more information, refer to the [service graph view documentation]({{< relref "../../metrics-generator/service-graph-view" >}}).
23+
For more information, refer to the [service graph view documentation](../../../metrics-generator/service-graph-view/).
2424

2525
## Before you begin
2626

@@ -70,4 +70,4 @@ metrics:
7070
The same service graph metrics can also be generated by Tempo.
7171
This is more efficient and recommended for larger installations.
7272

73-
For additional information about viewing service graph metrics in Grafana and calculating cardinality, refer to the [server side documentation]({{< relref "../../metrics-generator/service_graphs/enable-service-graphs" >}}).
73+
For additional information about viewing service graph metrics in Grafana and calculating cardinality, refer to the [server side documentation](../../../metrics-generator/service_graphs/enable-service-graphs/).

docs/sources/tempo/configuration/grafana-agent/span-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For more information, refer to [Migrate to Alloy](https://grafana.com/docs/tempo
4040

4141
The same span metrics can also be generated by Tempo.
4242
This is more efficient and recommended for larger installations.
43-
For a deep look into span metrics, visit [this section]({{< relref "../../metrics-generator/span_metrics" >}}).
43+
For a deep look into span metrics, visit [this section](../../../metrics-generator/span_metrics/).
4444

4545
## Example
4646

docs/sources/tempo/configuration/hosted-storage/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ aliases:
1111

1212
Tempo provides additional hosted storage configuration options discussed on the pages below. These options relate to providers such as Google Cloud, AWS S3, and Azure.
1313

14-
For additional details about storage configuration, refer to [Storage configuration]({{< relref "../../configuration#storage" >}}).
14+
For additional details about storage configuration, refer to [Storage configuration](../#storage).
1515

1616
{{< section withDescriptions="true">}}

docs/sources/tempo/configuration/hosted-storage/gcs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases:
77

88
# Google Cloud Storage
99

10-
For configuration options, check the storage section on the [configuration]({{< relref "../../configuration#storage" >}}) page.
10+
For configuration options, check the storage section on the [configuration](../../#storage) page.
1111

1212
## Permissions
1313

docs/sources/tempo/configuration/hosted-storage/s3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ aliases:
88

99
# Amazon S3 permissions
1010

11-
For configuration options, refer to the storage section on the [configuration]({{< relref "../../configuration#storage" >}}) page.
11+
For configuration options, refer to the storage section on the [configuration](../../#storage) page.
1212

1313
The following authentication methods are supported:
1414
- AWS environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`

docs/sources/tempo/configuration/manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ weight: 110
1010

1111
This document is a reference for all Tempo options and their defaults. If you are just getting
1212
started with Tempo, refer to [Tempo examples](https://github.com/grafana/tempo/tree/main/example/docker-compose)
13-
and other [configuration documentation]({{< relref "../configuration" >}}). Most installations will require only setting 10 to 20 of these options.
13+
and other [configuration documentation](../). Most installations will require only setting 10 to 20 of these options.
1414

1515
## Complete configuration
1616

docs/sources/tempo/configuration/parquet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 300
88
# Apache Parquet block format
99

1010
Tempo has a default columnar block format based on Apache Parquet.
11-
This format is required for tags-based search as well as [TraceQL]({{< relref "../traceql" >}}), the query language for traces.
11+
This format is required for tags-based search as well as [TraceQL](../../traceql/), the query language for traces.
1212
The columnar block format improves search performance and enables an ecosystem of tools, including [Tempo CLI](https://grafana.com/docs/tempo/<TEMPO_VERSION>/operations/tempo_cli/#analyse-blocks), to access the underlying trace data.
1313

1414
For more information, refer to the [Parquet design document](https://github.com/grafana/tempo/blob/main/docs/design-proposals/2022-04%20Parquet.md) and [Issue 1480](https://github.com/grafana/tempo/issues/1480).
@@ -53,7 +53,7 @@ To re-enable the default `vParquet4` format, remove the block version option fro
5353
## Parquet configuration parameters
5454

5555
Some parameters in the Tempo configuration are specific to Parquet.
56-
For more information, refer to the [storage configuration documentation]({{< relref "../configuration#storage" >}}).
56+
For more information, refer to the [storage configuration documentation](../#storage).
5757

5858
### Trace search parameters
5959

docs/sources/tempo/configuration/polling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ storage:
3535
[blocklist_poll_stale_tenant_index: <duration>]
3636
```
3737

38-
Due to the mechanics of the [tenant index]({{< relref "../operations/monitor/polling" >}}), the blocklist will be stale by
38+
Due to the mechanics of the [tenant index](../../operations/monitor/polling/), the blocklist will be stale by
3939
at most 2 times the configured `blocklist_poll` duration. There are two configuration options that need to be balanced
4040
against the `blockist_poll` to handle this:
4141

0 commit comments

Comments
 (0)