[release-v2.4] [DOC] Fix linter-related issues (#3581)

* Fix linter-related issues * Apply suggestions from code review * Update docs/sources/tempo/api_docs/pushing-spans-with-http.md (cherry picked from commit cd7619f) # Conflicts: # docs/sources/tempo/configuration/_index.md # docs/sources/tempo/operations/tempo_cli.md
grafana · Apr 16, 2024 · 74f4085 · 74f4085
1 parent d0b0a9c
commit 74f4085
Show file tree

Hide file tree

Showing 44 changed files with 695 additions and 187 deletions.
diff --git a/docs/sources/tempo/api_docs/_index.md b/docs/sources/tempo/api_docs/_index.md
diff --git a/docs/sources/tempo/api_docs/metrics-summary.md b/docs/sources/tempo/api_docs/metrics-summary.md
@@ -9,7 +9,7 @@ weight: 600
 
 # Metrics summary API
 
-{{% admonition type="warning" %}}
+{{< admonition type="warning" >}}
 The Metrics summary API is an [experimental feature](/docs/release-life-cycle) that is disabled by default. To enable it, adjust your configuration as suggested below.
 {{% /admonition %}}
 
@@ -45,9 +45,9 @@ All query parameters must be URL-encoded to preserve non-URL-safe characters in
 | Name | Examples | Definition | Required? |
 | --------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | --------- |
 | `q` | `{ resource.service.name = "foo" && span.http.status_code != 200 }` | The TraceQL query with full syntax. All spans matching this query are included in the calculations. Any valid TraceQL query is supported. | Yes |
-| `groupBy` | `name` <br /> `.foo` <br/> `resource.namespace` <br/> `span.http.url,span.http.status_code` <br> | One or more TraceQL values to group by. Any valid intrinsic or attribute with scope. To group by multiple values use a comma-delimited list.  | Yes |
-| `start ` | 1672549200 | Start of time range in Unix seconds. If not specified, then all recent data is queried.  | No |
-| `end` | 1672549200 | End of the time range in Unix seconds. If not specified, then all recent data is queried.  | No |
+| `groupBy` | `name` <br /> `.foo` <br/> `resource.namespace` <br/> `span.http.url,span.http.status_code` <br> | One or more TraceQL values to group by. Any valid intrinsic or attribute with scope. To group by multiple values use a comma-delimited list. | Yes |
+| `start ` | 1672549200 | Start of time range in Unix seconds. If not specified, then all recent data is queried. | No |
+| `end` | 1672549200 | End of the time range in Unix seconds. If not specified, then all recent data is queried. | No |
 
 Example:
 
@@ -89,7 +89,7 @@ message TraceQLStatic {
 
 The response is returned as JSON following [standard protobuf->JSON mapping rules](https://protobuf.dev/programming-guides/proto3/#json).
 
-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 The `uint64` fields cannot be fully expressed by JSON numeric values so the fields are serialized as strings.
 {{% /admonition %}}
 
@@ -119,21 +119,21 @@ Example:
 
 | Field | Notes |
 | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `summaries` | The list of metrics per group.  |
-| `.spanCount` | Number of spans in this group.  |
+| `summaries` | The list of metrics per group. |
+| `.spanCount` | Number of spans in this group. |
 | `.errorSpanCount` | Number of spans with `status`=`error`. (This field will not be present if the value is `0`.) |
-| `.series` | The unique values for this group. A key/value pair will be returned for each entry in `groupBy`.  |
-| `.key` | Key name.  |
-| `.value` | Value with TraceQL underlying type.  |
+| `.series` | The unique values for this group. A key/value pair will be returned for each entry in `groupBy`. |
+| `.key` | Key name. |
+| `.value` | Value with TraceQL underlying type. |
 | `.type` | Data type `enum`` defined [here](https://github.com/grafana/tempo/blob/main/pkg/traceql/enum_statics.go#L8) (This field will not be present if the value is `0`.) <br/>0 = `nil`<br/>3 = `integer`<br/> 4 = `float` <br/> 5 = `string`<br/> 6 = `bool`<br/> 7 = `duration`<br/> 8 = span status<br/> 9 = span kind |
-| `.n` | Populated if this is an integer value.  |
-| `.s` | Populated if this is a string value.  |
-| `.f` | Populated if this is a float value.  |
-| `.b` | Populated if this is a boolean value.  |
-| `.d` | Populated if this is a duration value.  |
-| `.status` | Populated if this is a span status value.  |
-| `.kind` | Populated if this is a span kind value.  |
-| `.p99` | The p99 latency of this group in nanoseconds.  |
-| `.p95` | The p95 latency of this group in nanoseconds.  |
-| `.p90` | The p90 latency of this group in nanoseconds.  |
-| `.p50` | The p50 latency of this group in nanoseconds.  |
+| `.n` | Populated if this is an integer value. |
+| `.s` | Populated if this is a string value. |
+| `.f` | Populated if this is a float value. |
+| `.b` | Populated if this is a boolean value. |
+| `.d` | Populated if this is a duration value. |
+| `.status` | Populated if this is a span status value. |
+| `.kind` | Populated if this is a span kind value. |
+| `.p99` | The p99 latency of this group in nanoseconds. |
+| `.p95` | The p95 latency of this group in nanoseconds. |
+| `.p90` | The p90 latency of this group in nanoseconds. |
+| `.p50` | The p50 latency of this group in nanoseconds. |
diff --git a/docs/sources/tempo/api_docs/pushing-spans-with-http.md b/docs/sources/tempo/api_docs/pushing-spans-with-http.md
@@ -8,7 +8,7 @@ aliases:
 # Push spans with HTTP
 
 Sometimes using a tracing system is intimidating because it seems like you need complex application instrumentation
-or a span ingestion pipeline in order to push spans.  This guide aims to show an extremely basic technique for
+or a span ingestion pipeline in order to push spans. This guide aims to show an extremely basic technique for
 pushing spans with HTTP/JSON from a Bash script using the [OpenTelemetry](https://opentelemetry.io/docs/specs/otlp/) receiver.
 
 ## Before you begin
@@ -96,7 +96,7 @@ Multiple the milliseconds value by 1,000,000 to turn it into nanoseconds. You ca
 
 ## Retrieve traces
 
-The easiest way to get the trace is to execute a simple curl command to Tempo.  The returned format is [OTLP](https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto).
+The easiest way to get the trace is to execute a simple curl command to Tempo. The returned format is [OTLP](https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto).
 
 1. Replace the trace ID in the `curl` command with the trace ID that was generated from the push. This information is is in the data that's sent with the `curl`. You could use Grafana’s Explorer page to find this, as shown in the previous section.
 
@@ -125,9 +125,9 @@ To format this in a more human-readable output, consider using a [tool such as `
 curl -G -s http://localhost:3200/api/search --data-urlencode 'q={ .service.name = "my.service" }' | jq
 ```
 
-## Spans from everything!
+## Spans from everything
 
-Tracing is not limited to enterprise languages with complex frameworks.  As you can see it's easy to store and track events from your js, python or bash scripts.
+Tracing is not limited to enterprise languages with complex frameworks. As you can see it's easy to store and track events from your js, python or bash scripts.
 You can use Tempo/distributed tracing today to trace CI pipelines, long running bash processes, python data processing flows, or anything else
 you can think of.
 

diff --git a/docs/sources/tempo/configuration/grafana-agent/automatic-logging.md b/docs/sources/tempo/configuration/grafana-agent/automatic-logging.md
@@ -27,8 +27,7 @@ While this approach is useful, it isn't as powerful as [TraceQL]({{< relref
 trace ID, to enable jumping from logs to traces, then read on!
 
 If you want to query the system directly, read the [TraceQL
-documentation]({{< relref "../../traceql" >}}). We doubt you'll
-be sad.
+documentation]({{< relref "../../traceql" >}}). 
 
 ## Configuration
 

diff --git a/docs/sources/tempo/configuration/hosted-storage/_index.md b/docs/sources/tempo/configuration/hosted-storage/_index.md
@@ -1,7 +1,7 @@
 ---
 title: Hosted storage
 menuTitle: Hosted storage
-description: Learn about Tempo's available hosted storage options and how to configure them.
+description: Learn about available hosted storage options and how to configure them.
 weight: 400
 aliases:
 - /docs/tempo/latest/configuration/

diff --git a/docs/sources/tempo/configuration/manifest.md b/docs/sources/tempo/configuration/manifest.md
@@ -17,7 +17,7 @@ go run ./cmd/tempo --storage.trace.backend=local --storage.trace.local.path=/tmp
 
 ## Complete configuration
 
-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 This manifest was generated on 2023-11-13.
 {{% /admonition %}}
 

diff --git a/docs/sources/tempo/configuration/network/_index.md b/docs/sources/tempo/configuration/network/_index.md
@@ -1,7 +1,7 @@
 ---
 title: Network options
 menuTitle: Network options
-description: Learn about Tempo's available network options and how to configure them.
+description: Learn about available network options and how to configure them.
 weight: 500
 ---
 

diff --git a/docs/sources/tempo/configuration/network/ipv6.md b/docs/sources/tempo/configuration/network/ipv6.md
@@ -10,7 +10,7 @@ aliases:
 
 Tempo can be configured to communicate between the components using Internet Protocol Version 6, or IPv6.
 
-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 The underlying infrastructure must support this address family. This configuration may be used in a single-stack IPv6 environment, or in a dual-stack environment where both IPv6 and IPv4 are present. In a dual-stack scenario, only one address family may be configured at a time, and all components must be configured for that address family.
 {{% /admonition %}}
 

diff --git a/docs/sources/tempo/configuration/network/sidecar-proxy.md b/docs/sources/tempo/configuration/network/sidecar-proxy.md
@@ -22,7 +22,7 @@ The overall network looks like this:
 
 ![Tempo distributed network overview](/static/img/docs/tempo/sidecar-proxy/tempo-network-sidecar-proxy-simple.svg)
 
-The low-level ring data for ingesters can be viewed by browsing to the `/ingester/ring` URL on a distributor.  It looks like this:
+The low-level ring data for ingesters can be viewed by browsing to the `/ingester/ring` URL on a distributor. It looks like this:
 
 ![Ring status with default port](/static/img/docs/tempo/sidecar-proxy/screenshot-tempo-sidecar.png)
 

diff --git a/docs/sources/tempo/configuration/network/tls.md b/docs/sources/tempo/configuration/network/tls.md
@@ -10,7 +10,7 @@ aliases:
 
 Tempo can be configured to communicate between the components using Transport Layer Security, or TLS.
 
-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 The ciphers and TLS version here are for example purposes only. We are not recommending which ciphers or TLS versions for use in production environments.
 {{% /admonition %}}
 

diff --git a/docs/sources/tempo/configuration/parquet.md b/docs/sources/tempo/configuration/parquet.md
@@ -1,7 +1,7 @@
 ---
 title: Apache Parquet block format
 menuTitle: Apache Parquet
-description: Learn about Tempo's Parquet block format.
+description: Learn about Parquet block format in Tempo.
 weight: 300
 ---
 
@@ -23,7 +23,7 @@ Block formats based on Parquet require more CPU and memory resources than the pr
 
 ## Choose a different block format
 
-The default block format is `vParquet3`, which is the latest iteration of Tempo's Parquet-based columnar block format.
+The default block format is `vParquet3`, which is the latest iteration of the Parquet-based columnar block format in Tempo.
 It introduces dedicated attribute columns, which improve query performance by storing attributes in own columns,
 rather than in the generic attribute key-value list.
 For more information, see [Dedicated attribute columns]({{< relref "../operations/tempo_cli" >}}).