From 4e5944cce205a31177b2b6102ea71f4d185a44d5 Mon Sep 17 00:00:00 2001 From: svrnm Date: Wed, 7 Jun 2023 14:38:05 +0200 Subject: [PATCH 1/5] Common weights for JS pages --- content/en/docs/instrumentation/js/api.md | 2 +- content/en/docs/instrumentation/js/automatic/_index.md | 2 +- .../en/docs/instrumentation/js/automatic/module-config.md | 2 +- content/en/docs/instrumentation/js/context.md | 2 +- content/en/docs/instrumentation/js/examples.md | 2 +- content/en/docs/instrumentation/js/exporters.md | 2 +- .../en/docs/instrumentation/js/getting-started/_index.md | 2 +- .../en/docs/instrumentation/js/getting-started/browser.md | 2 +- .../en/docs/instrumentation/js/getting-started/nodejs.md | 2 +- content/en/docs/instrumentation/js/libraries.md | 2 +- .../instrumentation/js/{instrumentation.md => manual.md} | 6 +++--- content/en/docs/instrumentation/js/propagation.md | 2 +- content/en/docs/instrumentation/js/resources.md | 2 +- content/en/docs/instrumentation/js/sampling.md | 2 +- content/en/docs/instrumentation/js/serverless.md | 2 +- 15 files changed, 17 insertions(+), 17 deletions(-) rename content/en/docs/instrumentation/js/{instrumentation.md => manual.md} (99%) diff --git a/content/en/docs/instrumentation/js/api.md b/content/en/docs/instrumentation/js/api.md index c6001c251535..bb21509bd90b 100644 --- a/content/en/docs/instrumentation/js/api.md +++ b/content/en/docs/instrumentation/js/api.md @@ -4,5 +4,5 @@ linkTitle: API redirect: https://open-telemetry.github.io/opentelemetry-js/ manualLinkTarget: _blank _build: { render: link } -weight: 50 +weight: 210 --- diff --git a/content/en/docs/instrumentation/js/automatic/_index.md b/content/en/docs/instrumentation/js/automatic/_index.md index a4d317409ef9..5a8d74d06bb8 100644 --- a/content/en/docs/instrumentation/js/automatic/_index.md +++ b/content/en/docs/instrumentation/js/automatic/_index.md @@ -1,7 +1,7 @@ --- title: Automatic Instrumentation linkTitle: Automatic -weight: 30 +weight: 20 --- Automatic instrumentation provides a way to instrument any Node.js application diff --git a/content/en/docs/instrumentation/js/automatic/module-config.md b/content/en/docs/instrumentation/js/automatic/module-config.md index 6058152ac72b..550fe2a00bd7 100644 --- a/content/en/docs/instrumentation/js/automatic/module-config.md +++ b/content/en/docs/instrumentation/js/automatic/module-config.md @@ -1,7 +1,7 @@ --- title: Automatic Instrumentation Configuration linkTitle: Configuration -weight: 45 +weight: 10 --- This module is highly configurable by setting diff --git a/content/en/docs/instrumentation/js/context.md b/content/en/docs/instrumentation/js/context.md index 07dd010a792d..87c83eb83e08 100644 --- a/content/en/docs/instrumentation/js/context.md +++ b/content/en/docs/instrumentation/js/context.md @@ -2,7 +2,7 @@ title: Context description: OpenTelemetry JavaScript Context API Documentation aliases: [/docs/instrumentation/js/api/context] -weight: 8 +weight: 60 --- In order for OpenTelemetry to work, it must store and propagate important diff --git a/content/en/docs/instrumentation/js/examples.md b/content/en/docs/instrumentation/js/examples.md index 1555c63c45ad..1eef6d79953a 100644 --- a/content/en/docs/instrumentation/js/examples.md +++ b/content/en/docs/instrumentation/js/examples.md @@ -2,7 +2,7 @@ title: Instrumentation Examples title: Examples aliases: [/docs/instrumentation/js/instrumentation_examples] -weight: 99 +weight: 220 --- Here are some of the resources for OpenTelemetry instrumentation examples. diff --git a/content/en/docs/instrumentation/js/exporters.md b/content/en/docs/instrumentation/js/exporters.md index 3de82b1ef716..533009ddff2e 100644 --- a/content/en/docs/instrumentation/js/exporters.md +++ b/content/en/docs/instrumentation/js/exporters.md @@ -1,6 +1,6 @@ --- title: Exporters -weight: 5 +weight: 50 spelling: cSpell:ignore proto nginx openzipkin --- diff --git a/content/en/docs/instrumentation/js/getting-started/_index.md b/content/en/docs/instrumentation/js/getting-started/_index.md index 2d7ef696c1ae..a0d75b6d4e9d 100644 --- a/content/en/docs/instrumentation/js/getting-started/_index.md +++ b/content/en/docs/instrumentation/js/getting-started/_index.md @@ -1,7 +1,7 @@ --- title: Getting Started aliases: [/docs/js/getting_started] -weight: 1 +weight: 10 --- These two guides for Node.js and the browser use simple examples in javascript diff --git a/content/en/docs/instrumentation/js/getting-started/browser.md b/content/en/docs/instrumentation/js/getting-started/browser.md index 5b81d75fc043..849bddf87a35 100644 --- a/content/en/docs/instrumentation/js/getting-started/browser.md +++ b/content/en/docs/instrumentation/js/getting-started/browser.md @@ -1,7 +1,7 @@ --- title: Browser aliases: [/docs/js/getting_started/browser] -weight: 3 +weight: 20 --- While this guide uses the example application presented below, the steps to diff --git a/content/en/docs/instrumentation/js/getting-started/nodejs.md b/content/en/docs/instrumentation/js/getting-started/nodejs.md index 575908db1ab8..115db48bfe74 100644 --- a/content/en/docs/instrumentation/js/getting-started/nodejs.md +++ b/content/en/docs/instrumentation/js/getting-started/nodejs.md @@ -3,7 +3,7 @@ title: Node.js description: Get telemetry for your app in less than 5 minutes! aliases: [/docs/js/getting_started/nodejs] spelling: cSpell:ignore rolldice autoinstrumentation autoinstrumentations KHTML -weight: 2 +weight: 10 --- This page will show you how to get started with OpenTelemetry in Node.js. diff --git a/content/en/docs/instrumentation/js/libraries.md b/content/en/docs/instrumentation/js/libraries.md index fc3efbceb88a..76d26a6c5de4 100644 --- a/content/en/docs/instrumentation/js/libraries.md +++ b/content/en/docs/instrumentation/js/libraries.md @@ -1,7 +1,7 @@ --- title: Using instrumentation libraries linkTitle: Libraries -weight: 3 +weight: 40 spelling: cSpell:ignore autoinstrumentation metapackage --- diff --git a/content/en/docs/instrumentation/js/instrumentation.md b/content/en/docs/instrumentation/js/manual.md similarity index 99% rename from content/en/docs/instrumentation/js/instrumentation.md rename to content/en/docs/instrumentation/js/manual.md index 86c9e143283b..5aa52322b15a 100644 --- a/content/en/docs/instrumentation/js/instrumentation.md +++ b/content/en/docs/instrumentation/js/manual.md @@ -1,7 +1,7 @@ --- -title: Instrumentation -aliases: [/docs/instrumentation/js/api/tracing] -weight: 4 +title: Manual +aliases: [/docs/instrumentation/js/api/tracing, /docs/instrumentation/js/instrumentation/] +weight: 30 spelling: cSpell:ignore Millis --- diff --git a/content/en/docs/instrumentation/js/propagation.md b/content/en/docs/instrumentation/js/propagation.md index c987a0ad99ac..29986bbcbe7a 100644 --- a/content/en/docs/instrumentation/js/propagation.md +++ b/content/en/docs/instrumentation/js/propagation.md @@ -2,7 +2,7 @@ title: Propagation description: Context propagation for the JS SDK aliases: [/docs/instrumentation/js/api/propagation] -weight: 7 +weight: 65 spelling: cSpell:ignore traceparent tracestate --- diff --git a/content/en/docs/instrumentation/js/resources.md b/content/en/docs/instrumentation/js/resources.md index 69f38ad56cbb..e62cd87b4bba 100644 --- a/content/en/docs/instrumentation/js/resources.md +++ b/content/en/docs/instrumentation/js/resources.md @@ -1,6 +1,6 @@ --- title: Resources -weight: 6 +weight: 70 --- A [resource][] represents the entity producing telemetry as resource attributes. diff --git a/content/en/docs/instrumentation/js/sampling.md b/content/en/docs/instrumentation/js/sampling.md index 31aa6a339700..b74fa378fb03 100644 --- a/content/en/docs/instrumentation/js/sampling.md +++ b/content/en/docs/instrumentation/js/sampling.md @@ -1,6 +1,6 @@ --- title: Sampling -weight: 9 +weight: 80 --- [Sampling](/docs/concepts/sampling/) is a process that restricts the amount of diff --git a/content/en/docs/instrumentation/js/serverless.md b/content/en/docs/instrumentation/js/serverless.md index 9c7ab9e49311..f1c56eca692c 100644 --- a/content/en/docs/instrumentation/js/serverless.md +++ b/content/en/docs/instrumentation/js/serverless.md @@ -1,6 +1,6 @@ --- title: Serverless -weight: 8 +weight: 90 spelling: cSpell:ignore otelwrapper --- From 6078fa27a941e629c31fbffb7a88d85ecec7d684 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Wed, 7 Jun 2023 14:46:38 +0200 Subject: [PATCH 2/5] Update content/en/docs/instrumentation/js/manual.md Co-authored-by: Patrice Chalin --- content/en/docs/instrumentation/js/manual.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/docs/instrumentation/js/manual.md b/content/en/docs/instrumentation/js/manual.md index 5aa52322b15a..43125bab5d2b 100644 --- a/content/en/docs/instrumentation/js/manual.md +++ b/content/en/docs/instrumentation/js/manual.md @@ -1,6 +1,8 @@ --- title: Manual -aliases: [/docs/instrumentation/js/api/tracing, /docs/instrumentation/js/instrumentation/] +aliases: + - /docs/instrumentation/js/api/tracing + - /docs/instrumentation/js/instrumentation weight: 30 spelling: cSpell:ignore Millis --- From da41a2cdabea21cf4f86d51b7624cf5bbb00ab2e Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Wed, 7 Jun 2023 14:46:57 +0200 Subject: [PATCH 3/5] Update serverless.md --- content/en/docs/instrumentation/js/serverless.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/instrumentation/js/serverless.md b/content/en/docs/instrumentation/js/serverless.md index f1c56eca692c..4477398feed5 100644 --- a/content/en/docs/instrumentation/js/serverless.md +++ b/content/en/docs/instrumentation/js/serverless.md @@ -1,6 +1,6 @@ --- title: Serverless -weight: 90 +weight: 100 spelling: cSpell:ignore otelwrapper --- From dccd32dc3ad6893ca466acf35bc0f94ac82fa7f5 Mon Sep 17 00:00:00 2001 From: svrnm Date: Wed, 7 Jun 2023 14:57:03 +0200 Subject: [PATCH 4/5] fix links --- content/en/docs/instrumentation/js/getting-started/nodejs.md | 2 +- content/en/docs/instrumentation/js/libraries.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/instrumentation/js/getting-started/nodejs.md b/content/en/docs/instrumentation/js/getting-started/nodejs.md index 115db48bfe74..3cc484cffa21 100644 --- a/content/en/docs/instrumentation/js/getting-started/nodejs.md +++ b/content/en/docs/instrumentation/js/getting-started/nodejs.md @@ -454,7 +454,7 @@ the console output, such as the following: ## Next Steps Enrich your instrumentation generated automatically with -[manual instrumentation](/docs/instrumentation/js/instrumentation) of your own +[manual instrumentation](/docs/instrumentation/js/manual) of your own codebase. This gets you customized observability data. You'll also want to configure an appropriate exporter to diff --git a/content/en/docs/instrumentation/js/libraries.md b/content/en/docs/instrumentation/js/libraries.md index 76d26a6c5de4..68ebae09d50d 100644 --- a/content/en/docs/instrumentation/js/libraries.md +++ b/content/en/docs/instrumentation/js/libraries.md @@ -256,7 +256,7 @@ You can also find more instrumentations available in the ## Next steps After you have set up instrumentation libraries, you may want to add -[manual instrumentation](/docs/instrumentation/js/instrumentation) to collect +[manual instrumentation](/docs/instrumentation/js/manual) to collect custom telemetry data. You'll also want to configure an appropriate exporter to From 0ac5149226e796571072f59cf3a8ebad8c5dc8d2 Mon Sep 17 00:00:00 2001 From: svrnm Date: Wed, 7 Jun 2023 16:59:46 +0200 Subject: [PATCH 5/5] fix format --- content/en/docs/instrumentation/js/getting-started/nodejs.md | 4 ++-- content/en/docs/instrumentation/js/libraries.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/instrumentation/js/getting-started/nodejs.md b/content/en/docs/instrumentation/js/getting-started/nodejs.md index 3cc484cffa21..c795c7ba19f2 100644 --- a/content/en/docs/instrumentation/js/getting-started/nodejs.md +++ b/content/en/docs/instrumentation/js/getting-started/nodejs.md @@ -454,8 +454,8 @@ the console output, such as the following: ## Next Steps Enrich your instrumentation generated automatically with -[manual instrumentation](/docs/instrumentation/js/manual) of your own -codebase. This gets you customized observability data. +[manual instrumentation](/docs/instrumentation/js/manual) of your own codebase. +This gets you customized observability data. You'll also want to configure an appropriate exporter to [export your telemetry data](/docs/instrumentation/js/exporters) to one or more diff --git a/content/en/docs/instrumentation/js/libraries.md b/content/en/docs/instrumentation/js/libraries.md index 68ebae09d50d..60e4e5ddff00 100644 --- a/content/en/docs/instrumentation/js/libraries.md +++ b/content/en/docs/instrumentation/js/libraries.md @@ -256,8 +256,8 @@ You can also find more instrumentations available in the ## Next steps After you have set up instrumentation libraries, you may want to add -[manual instrumentation](/docs/instrumentation/js/manual) to collect -custom telemetry data. +[manual instrumentation](/docs/instrumentation/js/manual) to collect custom +telemetry data. You'll also want to configure an appropriate exporter to [export your telemetry data](/docs/instrumentation/js/exporters) to one or more