Skip to content

Commit

Permalink
Put note into hugo.yaml
Browse files Browse the repository at this point in the history
Signed-off-by: svrnm <neumanns@cisco.com>
  • Loading branch information
svrnm authored and chalin committed Aug 3, 2023
1 parent c51e91f commit f3935c2
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 13 deletions.
3 changes: 3 additions & 0 deletions content/en/docs/instrumentation/js/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 1 addition & 9 deletions content/en/docs/instrumentation/js/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
3 changes: 3 additions & 0 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit f3935c2

Please sign in to comment.