diff --git a/content/en/_index.md b/content/en/_index.md index 0b9fab53edb9..f953d839d1db 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -18,9 +18,9 @@ mission_url: https://github.com/open-telemetry/community/blob/main/mission-visio
- [Collector]({{< relref "/docs/collector/getting-started" >}}) -- [Go]({{< relref "/docs/go/getting-started" >}}) -- [.NET]({{< relref "/docs/net/getting-started" >}}) -- [JavaScript]({{< relref "/docs/js/getting-started" >}}) +- [Go]({{< relref "/docs/instrumentation/go/getting-started" >}}) +- [.NET]({{< relref "/docs/instrumentation/net/getting-started" >}}) +- [JavaScript]({{< relref "/docs/instrumentation/js/getting-started" >}}) - []({{< relref "docs" >}})
{{< /blocks/cover >}} diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 6e8a9b500fa9..cae1710996e5 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -93,7 +93,7 @@ others. This page captures terminology used in the project and what it means. Libraries]({{< relref "/docs/reference/specification/trace/sdk#span-processor" >}}) and the [Collector](/docs/collector/configuration/#processors). -- **[Propagators](/docs/go/instrumentation/#propagators-and-context):** Used to +- **[Propagators](/docs/instrumentation/go/instrumentation/#propagators-and-context):** Used to serialize and deserialize specific parts of telemetry data such as span context and `Baggage` in `Spans`. - **[Proto](/docs/concepts/components/#proto):** Language independent interface types. diff --git a/content/en/docs/concepts/instrumenting-library.md b/content/en/docs/concepts/instrumenting-library.md index 5dbf3c8e0799..052bb7e626f7 100644 --- a/content/en/docs/concepts/instrumenting-library.md +++ b/content/en/docs/concepts/instrumenting-library.md @@ -171,9 +171,9 @@ try (Scope unused = span.makeCurrent()) { } ``` -Here're the full [examples of context extraction in Java](/docs/java/manual_instrumentation/#context-propagation), check out OpenTelemetry documentation in your language. +Here're the full [examples of context extraction in Java](/docs/instrumentation/java/manual_instrumentation/#context-propagation), check out OpenTelemetry documentation in your language. -In the case of a messaging system, you may receive more than one message at once. Received messages become [*links*](/docs/java/manual_instrumentation/#create-spans-with-links) on the span you create. +In the case of a messaging system, you may receive more than one message at once. Received messages become [*links*](/docs/instrumentation/java/manual_instrumentation/#create-spans-with-links) on the span you create. Refer to [messaging conventions]({{< relref "/docs/reference/specification/trace/semantic_conventions/messaging" >}}) for details (WARNING: messaging conventions are [under constructions](https://github.com/open-telemetry/oteps/pull/173) 🚧). ### Injecting context @@ -200,7 +200,7 @@ try (Scope unused = span.makeCurrent()) { } ``` -Here's the full [example of context injection in Java](/docs/java/manual_instrumentation/#context-propagation). +Here's the full [example of context injection in Java](/docs/instrumentation/java/manual_instrumentation/#context-propagation). There might be some exceptions: diff --git a/content/en/docs/go b/content/en/docs/go deleted file mode 120000 index 0274f85f2956..000000000000 --- a/content/en/docs/go +++ /dev/null @@ -1 +0,0 @@ -../../../content-modules/opentelemetry-go/website_docs \ No newline at end of file diff --git a/content/en/docs/instrumentation/_index.md b/content/en/docs/instrumentation/_index.md new file mode 100644 index 000000000000..1a09b8931a34 --- /dev/null +++ b/content/en/docs/instrumentation/_index.md @@ -0,0 +1,13 @@ +--- +title: Instrumentation +weight: 2 +--- + +OpenTelemetry code instrumentation is supported for the languages listed below. +Depending on the language, topics covered will include some or all of the +following: + +- Automatic instrumentation +- Manual instrumentation +- Exporting data + diff --git a/content/en/docs/cpp/_index.md b/content/en/docs/instrumentation/cpp/_index.md similarity index 100% rename from content/en/docs/cpp/_index.md rename to content/en/docs/instrumentation/cpp/_index.md diff --git a/content/en/docs/erlang/_index.md b/content/en/docs/instrumentation/erlang/_index.md similarity index 100% rename from content/en/docs/erlang/_index.md rename to content/en/docs/instrumentation/erlang/_index.md diff --git a/content/en/docs/erlang/getting-started.md b/content/en/docs/instrumentation/erlang/getting-started.md similarity index 100% rename from content/en/docs/erlang/getting-started.md rename to content/en/docs/instrumentation/erlang/getting-started.md diff --git a/content/en/docs/erlang/instrumentation.md b/content/en/docs/instrumentation/erlang/instrumentation.md similarity index 100% rename from content/en/docs/erlang/instrumentation.md rename to content/en/docs/instrumentation/erlang/instrumentation.md diff --git a/content/en/docs/instrumentation/go b/content/en/docs/instrumentation/go new file mode 120000 index 000000000000..7ea3a070c22f --- /dev/null +++ b/content/en/docs/instrumentation/go @@ -0,0 +1 @@ +../../../../content-modules/opentelemetry-go/website_docs \ No newline at end of file diff --git a/content/en/docs/instrumentation/java b/content/en/docs/instrumentation/java new file mode 120000 index 000000000000..9b88151dc85c --- /dev/null +++ b/content/en/docs/instrumentation/java @@ -0,0 +1 @@ +../../../../content-modules/opentelemetry-java/website_docs \ No newline at end of file diff --git a/content/en/docs/js/_index.md b/content/en/docs/instrumentation/js/_index.md similarity index 100% rename from content/en/docs/js/_index.md rename to content/en/docs/instrumentation/js/_index.md diff --git a/content/en/docs/js/api/_index.md b/content/en/docs/instrumentation/js/api/_index.md similarity index 100% rename from content/en/docs/js/api/_index.md rename to content/en/docs/instrumentation/js/api/_index.md diff --git a/content/en/docs/js/api/context.md b/content/en/docs/instrumentation/js/api/context.md similarity index 100% rename from content/en/docs/js/api/context.md rename to content/en/docs/instrumentation/js/api/context.md diff --git a/content/en/docs/js/api/tracing.md b/content/en/docs/instrumentation/js/api/tracing.md similarity index 100% rename from content/en/docs/js/api/tracing.md rename to content/en/docs/instrumentation/js/api/tracing.md diff --git a/content/en/docs/js/exporters.md b/content/en/docs/instrumentation/js/exporters.md similarity index 100% rename from content/en/docs/js/exporters.md rename to content/en/docs/instrumentation/js/exporters.md diff --git a/content/en/docs/js/getting-started/_index.md b/content/en/docs/instrumentation/js/getting-started/_index.md similarity index 100% rename from content/en/docs/js/getting-started/_index.md rename to content/en/docs/instrumentation/js/getting-started/_index.md diff --git a/content/en/docs/js/getting-started/browser.md b/content/en/docs/instrumentation/js/getting-started/browser.md similarity index 100% rename from content/en/docs/js/getting-started/browser.md rename to content/en/docs/instrumentation/js/getting-started/browser.md diff --git a/content/en/docs/js/getting-started/nodejs.md b/content/en/docs/instrumentation/js/getting-started/nodejs.md similarity index 100% rename from content/en/docs/js/getting-started/nodejs.md rename to content/en/docs/instrumentation/js/getting-started/nodejs.md diff --git a/content/en/docs/js/instrumentation.md b/content/en/docs/instrumentation/js/instrumentation.md similarity index 100% rename from content/en/docs/js/instrumentation.md rename to content/en/docs/instrumentation/js/instrumentation.md diff --git a/content/en/docs/js/instrumentation_examples.md b/content/en/docs/instrumentation/js/instrumentation_examples.md similarity index 100% rename from content/en/docs/js/instrumentation_examples.md rename to content/en/docs/instrumentation/js/instrumentation_examples.md diff --git a/content/en/docs/net/_index.md b/content/en/docs/instrumentation/net/_index.md similarity index 100% rename from content/en/docs/net/_index.md rename to content/en/docs/instrumentation/net/_index.md diff --git a/content/en/docs/net/getting-started.md b/content/en/docs/instrumentation/net/getting-started.md similarity index 100% rename from content/en/docs/net/getting-started.md rename to content/en/docs/instrumentation/net/getting-started.md diff --git a/content/en/docs/instrumentation/php b/content/en/docs/instrumentation/php new file mode 120000 index 000000000000..d2806a100580 --- /dev/null +++ b/content/en/docs/instrumentation/php @@ -0,0 +1 @@ +../../../../content-modules/opentelemetry-php/website_docs \ No newline at end of file diff --git a/content/en/docs/instrumentation/python b/content/en/docs/instrumentation/python new file mode 120000 index 000000000000..3df94f323223 --- /dev/null +++ b/content/en/docs/instrumentation/python @@ -0,0 +1 @@ +../../../../content-modules/opentelemetry-python/website_docs \ No newline at end of file diff --git a/content/en/docs/instrumentation/ruby b/content/en/docs/instrumentation/ruby new file mode 120000 index 000000000000..8f44156cd58d --- /dev/null +++ b/content/en/docs/instrumentation/ruby @@ -0,0 +1 @@ +../../../../content-modules/opentelemetry-ruby/website_docs \ No newline at end of file diff --git a/content/en/docs/rust/_index.md b/content/en/docs/instrumentation/rust/_index.md similarity index 100% rename from content/en/docs/rust/_index.md rename to content/en/docs/instrumentation/rust/_index.md diff --git a/content/en/docs/swift/_index.md b/content/en/docs/instrumentation/swift/_index.md similarity index 100% rename from content/en/docs/swift/_index.md rename to content/en/docs/instrumentation/swift/_index.md diff --git a/content/en/docs/java b/content/en/docs/java deleted file mode 120000 index 97ac4f22f3d2..000000000000 --- a/content/en/docs/java +++ /dev/null @@ -1 +0,0 @@ -../../../content-modules/opentelemetry-java/website_docs \ No newline at end of file diff --git a/content/en/docs/php b/content/en/docs/php deleted file mode 120000 index 664532702454..000000000000 --- a/content/en/docs/php +++ /dev/null @@ -1 +0,0 @@ -../../../content-modules/opentelemetry-php/website_docs \ No newline at end of file diff --git a/content/en/docs/python b/content/en/docs/python deleted file mode 120000 index 59f161245f9e..000000000000 --- a/content/en/docs/python +++ /dev/null @@ -1 +0,0 @@ -../../../content-modules/opentelemetry-python/website_docs \ No newline at end of file diff --git a/content/en/docs/ruby b/content/en/docs/ruby deleted file mode 120000 index 545d501fb73f..000000000000 --- a/content/en/docs/ruby +++ /dev/null @@ -1 +0,0 @@ -../../../content-modules/opentelemetry-ruby/website_docs \ No newline at end of file diff --git a/layouts/index.redirects b/layouts/index.redirects index ba4057ef0954..228f486e72eb 100644 --- a/layouts/index.redirects +++ b/layouts/index.redirects @@ -8,3 +8,10 @@ # https://github.com/open-telemetry/opentelemetry.io/issues/635#issuecomment-953920483 /docs/java/automatic_instrumentation https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/README.md /docs/java/getting_started https://opentelemetry.io/docs/java/manual_instrumentation/ + +{{ $languages := (.Site.GetPage "/docs/instrumentation").Pages -}} +{{ range $languages -}} +{{ $lang := .File.ContentBaseName -}} +/docs/{{ $lang }} /docs/instrumentation/{{ $lang }} +/docs/{{ $lang }}/* /docs/instrumentation/{{ $lang }}/:splat +{{ end -}} \ No newline at end of file