From 261eb3ccde2d87d268ba8587e78c378d7b331df5 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Wed, 8 Jun 2022 22:43:20 +0200 Subject: [PATCH] Some fixes for concept pages (#1429) --- content/en/docs/concepts/_index.md | 2 +- content/en/docs/concepts/data-collection.md | 2 +- content/en/docs/concepts/glossary.md | 24 ++++++++++----------- content/en/docs/concepts/signals/logs.md | 2 +- content/en/docs/concepts/signals/metrics.md | 2 +- content/en/docs/concepts/signals/traces.md | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/content/en/docs/concepts/_index.md b/content/en/docs/concepts/_index.md index 4a0273465..d7a1e969e 100644 --- a/content/en/docs/concepts/_index.md +++ b/content/en/docs/concepts/_index.md @@ -7,6 +7,6 @@ aliases: [/about, /docs/concepts/overview, /otel] weight: 1 --- -The Concepts section helps you learn more about the data sources and components +The concepts section helps you learn more about the data sources and components of the OpenTelemetry project in order to obtain a deeper understanding of how OpenTelemetry works. diff --git a/content/en/docs/concepts/data-collection.md b/content/en/docs/concepts/data-collection.md index 50a6a46f7..49d3b421b 100644 --- a/content/en/docs/concepts/data-collection.md +++ b/content/en/docs/concepts/data-collection.md @@ -22,7 +22,7 @@ The OpenTelemetry Collector provides a single binary and two deployment methods: - **Agent:** A Collector instance running with the application or on the same host as the application (e.g. binary, sidecar, or daemonset). - **Gateway:** One or more Collector instances running as a standalone service - (e.g. container or deployment) typically per cluster, datacenter or region. + (e.g. container or deployment) typically per cluster, data center or region. For information on how to use the Collector see the [getting started documentation](/docs/collector/getting-started). diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index ad30aa4a6..56afa805e 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -175,7 +175,7 @@ A name/value pair added to telemetry data. OpenTelemetry calls this ### **Metric** Records a data point, either raw measurements or predefined aggregation, as -timeseries with [`Metadata`](#metadata). See [more][metric]. +time series with [`Metadata`](#metadata). See [more][metric]. ### **OC** @@ -277,7 +277,7 @@ scalability. A [`Service`](#service) may be deployed in multiple locations. ### **Signal** -One of [`Traces`](#trace), [`Metrics`](#metric) or [`Logs`](#log). More on +One of [`Traces`](#trace), [`Metrics`](#metric) or [`Logs`](#log). More on Signals [here][signals]. ### **Span** @@ -328,31 +328,31 @@ on web pages when requested. See [more][zpages]. ### Traces -##### **[Trace API Terminology](/docs/reference/specification/trace/api)** +#### **[Trace API Terminology](/docs/reference/specification/trace/api)** -##### **[Trace SDK Terminology](/docs/reference/specification/trace/sdk)** +#### **[Trace SDK Terminology](/docs/reference/specification/trace/sdk)** ### Metrics -##### **[Metric API Terminology](/docs/reference/specification/metrics/api#overview)** +#### **[Metric API Terminology](/docs/reference/specification/metrics/api#overview)** -##### **[Metric SDK Terminology](/docs/reference/specification/metrics#specifications)** +#### **[Metric SDK Terminology](/docs/reference/specification/metrics#specifications)** ### Logs -##### **[Trace Context Fields](/docs/reference/specification/logs/data-model#trace-context-fields)** +#### **[Trace Context Fields](/docs/reference/specification/logs/data-model#trace-context-fields)** -##### **[Severity Fields](/docs/reference/specification/logs/data-model#severity-fields)** +#### **[Severity Fields](/docs/reference/specification/logs/data-model#severity-fields)** -##### **[Log Record Fields](/docs/reference/specification/logs/data-model#log-and-event-record-definition)** +#### **[Log Record Fields](/docs/reference/specification/logs/data-model#log-and-event-record-definition)** ### Semantic Conventions -##### **[Resource Conventions](/docs/reference/specification/resource/semantic_conventions)** +#### **[Resource Conventions](/docs/reference/specification/resource/semantic_conventions)** -##### **[Span Conventions](/docs/reference/specification/trace/semantic_conventions)** +#### **[Span Conventions](/docs/reference/specification/trace/semantic_conventions)** -##### **[Metric Conventions](/docs/reference/specification/metrics/semantic_conventions)** +#### **[Metric Conventions](/docs/reference/specification/metrics/semantic_conventions)** [baggage]: /docs/reference/specification/baggage/api/ [attribute]: /docs/reference/specification/common/#attributes diff --git a/content/en/docs/concepts/signals/logs.md b/content/en/docs/concepts/signals/logs.md index 10e313164..3ff16c6a2 100644 --- a/content/en/docs/concepts/signals/logs.md +++ b/content/en/docs/concepts/signals/logs.md @@ -15,4 +15,4 @@ the change. > For more information, see the [logs specification][]. -[logs specification]: /docs/reference/specification/overview/#log-signal \ No newline at end of file +[logs specification]: /docs/reference/specification/overview/#log-signal diff --git a/content/en/docs/concepts/signals/metrics.md b/content/en/docs/concepts/signals/metrics.md index e98e695a4..a604599b5 100644 --- a/content/en/docs/concepts/signals/metrics.md +++ b/content/en/docs/concepts/signals/metrics.md @@ -49,4 +49,4 @@ metrics include: > For more information, see the [metrics specification][]. -[metrics specification]: /docs/reference/specification/overview/#metric-signal \ No newline at end of file +[metrics specification]: /docs/reference/specification/overview/#metric-signal diff --git a/content/en/docs/concepts/signals/traces.md b/content/en/docs/concepts/signals/traces.md index d91b96316..86d5b38a7 100644 --- a/content/en/docs/concepts/signals/traces.md +++ b/content/en/docs/concepts/signals/traces.md @@ -81,7 +81,7 @@ Sample Trace: }, "events": [ { - "name": "Guten tag!", + "name": "Guten Tag!", "timestamp": "2022-04-29T18:52:58.114561Z", "attributes": { "event_attributes": 1