From fffa00d751366685f9b60c77f30c26e005c112b3 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 11 May 2023 16:27:55 -0400 Subject: [PATCH] [website_docs] Update path to spec, run formatter --- CONTRIBUTING.md | 4 ++-- website_docs/exporters.md | 14 +++++++++----- website_docs/getting-started.md | 4 ++-- website_docs/libraries.md | 2 +- website_docs/manual.md | 5 ++--- 5 files changed, 16 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21642f2f301..949a275616b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,10 +150,10 @@ Any [Maintainer] can merge the PR once the above criteria have been met. ## Design Choices As with other OpenTelemetry clients, opentelemetry-go follows the -[OpenTelemetry Specification](https://opentelemetry.io/docs/reference/specification). +[OpenTelemetry Specification](https://opentelemetry.io/docs/specs/otel). It's especially valuable to read through the [library -guidelines](https://opentelemetry.io/docs/reference/specification/library-guidelines). +guidelines](https://opentelemetry.io/docs/specs/otel/library-guidelines). ### Focus on Capabilities, Not Structure Compliance diff --git a/website_docs/exporters.md b/website_docs/exporters.md index ddd346c40d2..40659f91b71 100644 --- a/website_docs/exporters.md +++ b/website_docs/exporters.md @@ -10,7 +10,8 @@ and metrics, you will need to export them to a backend. ## OTLP endpoint To send trace data to an OTLP endpoint (like the [collector](/docs/collector) or -Jaeger >= v1.35.0) you'll want to configure an OTLP exporter that sends to your endpoint. +Jaeger >= v1.35.0) you'll want to configure an OTLP exporter that sends to your +endpoint. ### Using HTTP @@ -30,12 +31,13 @@ func installExportPipeline(ctx context.Context) (func(context.Context) error, er } ``` -To learn more on how to use the OTLP HTTP exporter, try out the [otel-collector](https://github.com/open-telemetry/opentelemetry-go/tree/main/example/otel-collector) +To learn more on how to use the OTLP HTTP exporter, try out the +[otel-collector](https://github.com/open-telemetry/opentelemetry-go/tree/main/example/otel-collector) ### Jaeger To try out the OTLP exporter, since v1.35.0 you can run -[Jaeger](https://www.jaegertracing.io/) as an OTLP endpoint and for trace +[Jaeger](https://www.jaegertracing.io/) as an OTLP endpoint and for trace visualization in a docker container: ```shell @@ -48,6 +50,8 @@ docker run -d --name jaeger \ ## Prometheus -Prometheus export is available in the `go.opentelemetry.io/otel/exporters/prometheus` package. +Prometheus export is available in the +`go.opentelemetry.io/otel/exporters/prometheus` package. -Please find more documentation on [GitHub](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/prometheus) +Please find more documentation on +[GitHub](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/prometheus) diff --git a/website_docs/getting-started.md b/website_docs/getting-started.md index c8327f133c9..e415380b866 100644 --- a/website_docs/getting-started.md +++ b/website_docs/getting-started.md @@ -190,8 +190,8 @@ With the imports added, you can start instrumenting. The OpenTelemetry Tracing API provides a [`Tracer`] to create traces. These [`Tracer`]s are designed to be associated with one instrumentation library. That way telemetry they produce can be understood to come from that part of a code -base. To uniquely identify your application to the [`Tracer`] you will -create a constant with the package name in `app.go`. +base. To uniquely identify your application to the [`Tracer`] you will create a +constant with the package name in `app.go`. ```go // name is the Tracer name used to identify this instrumentation library. diff --git a/website_docs/libraries.md b/website_docs/libraries.md index 6c6028456c7..a441bf51b7a 100644 --- a/website_docs/libraries.md +++ b/website_docs/libraries.md @@ -9,7 +9,7 @@ weight: 3 Go does not support truly automatic instrumentation like other languages today. Instead, you'll need to depend on -[instrumentation libraries](/docs/reference/specification/glossary/#instrumentation-library) +[instrumentation libraries](/docs/specs/otel/glossary/#instrumentation-library) that generate telemetry data for a particular instrumented library. For example, the instrumentation library for `net/http` will automatically create spans that track inbound and outbound requests once you configure it in your code. diff --git a/website_docs/manual.md b/website_docs/manual.md index dc17bacab92..ec77577430c 100644 --- a/website_docs/manual.md +++ b/website_docs/manual.md @@ -297,7 +297,6 @@ After configuring context propagation, you'll most likely want to use automatic instrumentation to handle the behind-the-scenes work of actually managing serializing the context. -[opentelemetry specification]: /docs/reference/specification/ -[trace semantic conventions]: - /docs/reference/specification/trace/semantic_conventions/ +[opentelemetry specification]: /docs/specs/otel/ +[trace semantic conventions]: /docs/specs/otel/trace/semantic_conventions/ [instrumentation library]: ../libraries/