8000 [website_docs] Update path to spec, run formatter (#4084) · open-telemetry/opentelemetry-go@1dff818 · GitHub
[go: up one dir, main page]

Skip to content

Commit 1dff818

Browse files
[website_docs] Update path to spec, run formatter (#4084)
Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com>
1 parent c04c04c commit 1dff818

File tree

5 files changed

+16
-13
lines changed

5 files changed

+16
-13
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,10 @@ Any [Maintainer] can merge the PR once the above criteria have been met.
150150
## Design Choices
151151

152152
As with other OpenTelemetry clients, opentelemetry-go follows the
153-
[OpenTelemetry Specification](https://opentelemetry.io/docs/reference/specification).
153+
[OpenTelemetry Specification](https://opentelemetry.io/docs/specs/otel).
154154

155155
It's especially valuable to read through the [library
156-
guidelines](https://opentelemetry.io/docs/reference/specification/library-guidelines).
156+
guidelines](https://opentelemetry.io/docs/specs/otel/library-guidelines).
157157

158158
### Focus on Capabilities, Not Structure Compliance
159159

website_docs/exporters.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ and metrics, you will need to export them to a backend.
1010
## OTLP endpoint
1111

1212
To send trace data to an OTLP endpoint (like the [collector](/docs/collector) or
13-
Jaeger >= v1.35.0) you'll want to configure an OTLP exporter that sends to your endpoint.
13+
Jaeger >= v1.35.0) you'll want to configure an OTLP exporter that sends to your
14+
endpoint.
1415

1516
### Using HTTP
1617

@@ -30,12 +31,13 @@ func installExportPipeline(ctx context.Context) (func(context.Context) error, er
3031
}
3132
```
3233

33-
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)
34+
To learn more on how to use the OTLP HTTP exporter, try out the
35+
[otel-collector](https://github.com/open-telemetry/opentelemetry-go/tree/main/example/otel-collector)
3436

3537
### Jaeger
3638

3739
To try out the OTLP exporter, since v1.35.0 you can run
38-
[Jaeger](https://www.jaegertracing.io/) as an OTLP endpoint and for trace
40+
[Jaeger](https://www.jaegertracing.io/) as an OTLP endpoint and for trace
3941
visualization in a docker container:
4042

4143
```shell
@@ -48,6 +50,8 @@ docker run -d --name jaeger \
4850

4951
## Prometheus
5052

51-
Prometheus export is available in the `go.opentelemetry.io/otel/exporters/prometheus` package.
53+
Prometheus export is available in the
54+
`go.opentelemetry.io/otel/exporters/prometheus` package.
5255

53-
Please find more documentation on [GitHub](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/prometheus)
56+
Please find more documentation on
57+
[GitHub](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/prometheus)

website_docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ With the imports added, you can start instrumenting.
190190
The OpenTelemetry Tracing API provides a [`Tracer`] to create traces. These
191191
[`Tracer`]s are designed to be associated with one instrumentation library. That
192192
way telemetry they produce can be understood to come from that part of a code
193-
base. To uniquely identify your application to the [`Tracer`] you will
194-
create a constant with the package name in `app.go`.
193+
base. To uniquely identify your application to the [`Tracer`] you will create a
194+
constant with the package name in `app.go`.
195195

196196
```go
197197
// name is the Tracer name used to identify this instrumentation library.

website_docs/libraries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight: 3
99

1010
Go does not support truly automatic instrumentation like other languages today.
1111
Instead, you'll need to depend on
12-
[instrumentation libraries](/docs/reference/specification/glossary/#instrumentation-library)
12+
[instrumentation libraries](/docs/specs/otel/glossary/#instrumentation-library)
1313
that generate telemetry data for a particular instrumented library. For example,
1414
the instrumentation library for `net/http` will automatically create spans that
1515
track inbound and outbound requests once you configure it in your code.

website_docs/manual.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,6 @@ After configuring context propagation, you'll most likely want to use automatic
297297
instrumentation to handle the behind-the-scenes work of actually managing
298298
serializing the context.
299299

300-
[opentelemetry specification]: /docs/reference/specification/
301-
[trace semantic conventions]:
302-
/docs/reference/specification/trace/semantic_conventions/
300+
[opentelemetry specification]: /docs/specs/otel/
301+
[trace semantic conventions]: /docs/specs/otel/trace/semantic_conventions/
303302
[instrumentation library]: ../libraries/

0 commit comments

Comments
 (0)
0