Add a warning to browser getting started (#3125)

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
open-telemetry · Aug 3, 2023 · 249f954 · 249f954
1 parent 929ab15
commit 249f954
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git 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
@@ -4,6 +4,9 @@ aliases: [/docs/js/getting_started/browser]
 weight: 20
 ---
 
+{{% alert title="Warning" color="warning" %}}
+{{% _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
@@ -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
@@ -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: