From 8a0e8b1ad426107f9b19bd7a4651706880716fc7 Mon Sep 17 00:00:00 2001 From: svrnm Date: Wed, 2 Aug 2023 14:42:10 +0200 Subject: [PATCH 1/3] Add a warning to browser getting started Signed-off-by: svrnm --- .../instrumentation/js/getting-started/browser.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/en/docs/instrumentation/js/getting-started/browser.md b/content/en/docs/instrumentation/js/getting-started/browser.md index 5cc22fda078c..82cf241821b2 100644 --- a/content/en/docs/instrumentation/js/getting-started/browser.md +++ b/content/en/docs/instrumentation/js/getting-started/browser.md @@ -4,6 +4,17 @@ aliases: [/docs/js/getting_started/browser] weight: 20 --- +{{% alert title="Warning" color="warning" %}} + +Instrumentation for the browser is experimental and this is mostly unspecified: +this may break in the future. If you want to help changing that, you can join +the Client Instrumentation SIG on CNCF Slack channel +[#otel-client-side-telemetry](https://cloud-native.slack.com/archives/C0239SYARD2) +or by attending +[their meetings](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit) + +{{% /alert %}} + While this guide uses the example application presented below, the steps to instrument your own application should be similar. From c51e91f2a83c73b74dd61b08e780c2e95afab4b6 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Thu, 3 Aug 2023 16:55:52 +0200 Subject: [PATCH 2/3] Update content/en/docs/instrumentation/js/getting-started/browser.md Co-authored-by: Patrice Chalin --- .../en/docs/instrumentation/js/getting-started/browser.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/content/en/docs/instrumentation/js/getting-started/browser.md b/content/en/docs/instrumentation/js/getting-started/browser.md index 82cf241821b2..794ef707b5d0 100644 --- a/content/en/docs/instrumentation/js/getting-started/browser.md +++ b/content/en/docs/instrumentation/js/getting-started/browser.md @@ -6,12 +6,7 @@ weight: 20 {{% alert title="Warning" color="warning" %}} -Instrumentation for the browser is experimental and this is mostly unspecified: -this may break in the future. If you want to help changing that, you can join -the Client Instrumentation SIG on CNCF Slack channel -[#otel-client-side-telemetry](https://cloud-native.slack.com/archives/C0239SYARD2) -or by attending -[their meetings](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit) +Browser instrumentation **experimental**. If you are interested in helping out, see [Contributing](https://github.com/open-telemetry/opentelemetry-js#contributing). {{% /alert %}} From f3935c2ba92fcf9413981f716d8a54b5cfabd185 Mon Sep 17 00:00:00 2001 From: svrnm Date: Thu, 3 Aug 2023 17:17:13 +0200 Subject: [PATCH 3/3] Put note into hugo.yaml Signed-off-by: svrnm --- content/en/docs/instrumentation/js/_index.md | 3 +++ .../docs/instrumentation/js/getting-started/browser.md | 5 +---- content/en/docs/instrumentation/js/manual.md | 10 +--------- hugo.yaml | 3 +++ 4 files changed, 8 insertions(+), 13 deletions(-) diff --git a/content/en/docs/instrumentation/js/_index.md b/content/en/docs/instrumentation/js/_index.md index bd4ce33d5e9f..3bc9d6f66653 100644 --- a/content/en/docs/instrumentation/js/_index.md +++ b/content/en/docs/instrumentation/js/_index.md @@ -11,6 +11,9 @@ weight: 20 {{% docs/instrumentation/index-intro js /%}} +{{% alert title="Warning" color="warning" %}} +{{% _param notes.browser-instrumentation %}} {{% /alert %}} + ## Further Reading - [OpenTelemetry for JavaScript on GitHub](https://github.com/open-telemetry/opentelemetry-js) diff --git a/content/en/docs/instrumentation/js/getting-started/browser.md b/content/en/docs/instrumentation/js/getting-started/browser.md index 794ef707b5d0..ed7eac94c3a4 100644 --- a/content/en/docs/instrumentation/js/getting-started/browser.md +++ b/content/en/docs/instrumentation/js/getting-started/browser.md @@ -5,10 +5,7 @@ weight: 20 --- {{% alert title="Warning" color="warning" %}} - -Browser instrumentation **experimental**. If you are interested in helping out, see [Contributing](https://github.com/open-telemetry/opentelemetry-js#contributing). - -{{% /alert %}} +{{% _param notes.browser-instrumentation %}} {{% /alert %}} While this guide uses the example application presented below, the steps to instrument your own application should be similar. diff --git a/content/en/docs/instrumentation/js/manual.md b/content/en/docs/instrumentation/js/manual.md index 4fa966273b8a..190b130d5d89 100644 --- a/content/en/docs/instrumentation/js/manual.md +++ b/content/en/docs/instrumentation/js/manual.md @@ -332,15 +332,7 @@ above, you have a `TracerProvider` setup for you already. You can continue with #### Browser {{% alert title="Warning" color="warning" %}} - -Instrumentation for the browser is experimental and this is mostly unspecified: -this may break in the future. If you want to help changing that, you can join -the Client Instrumentation SIG on CNCF Slack channel -[#otel-client-side-telemetry](https://cloud-native.slack.com/archives/C0239SYARD2) -or by attending -[their meetings](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit) - -{{% /alert %}} +{{% _param notes.browser-instrumentation %}} {{% /alert %}} First, ensure you've got the right packages: diff --git a/hugo.yaml b/hugo.yaml index 3fc62c03773a..f523bf3e0a9b 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -171,6 +171,9 @@ params: docker-compose-v2: | `docker-compose` is deprecated. For details, see [Migrate to Compose V2](https://docs.docker.com/compose/migrate/). + browser-instrumentation: | + Client instrumentation for the browser is **experimental** and mostly **unspecified**. If you are interested in + helping out, get in touch with the [Client Instrumentation SIG](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit) services: googleAnalytics: