Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare documentation update for OTel JS SDK 2.0 #6396

Open
pichlermarc opened this issue Feb 21, 2025 · 2 comments
Open

Prepare documentation update for OTel JS SDK 2.0 #6396

pichlermarc opened this issue Feb 21, 2025 · 2 comments
Assignees

Comments

@pichlermarc
Copy link
Member

pichlermarc commented Feb 21, 2025

What needs to be changed?

Over at the OpenTelemetry JavaScript SIG, we're currently gearing up to publishing a first pre-release of the OTel JS SDK 2.0, and an actual release after that (see open-telemetry/opentelemetry-js#5148). The new major release of the SDK will require end-users to change their SDK setup in some ways - the @opentelemetry/api package will stay at 1.x, of course - so instrumentation-related code should stay the same.

Since SDK setup will change, some docs pages also need to be adapted.

Since I have a lot of context having reviewed most of the PRs that will make it into the 2.0 release, I'd like to volunteer to work on updating the docs in two PRs:

  1. removing use of deprecated APIs (can be merged immediately as the replacements for these are already present in the latest release)
  2. adapting the SDK setup to follow the "new" way of doing things that's only possible in SDK 2.0 (can be merged once we've actually released SDK 2.0 - Ideally I'd like to then coordinate on timing so that the new docs go live when we publish the release)

What is the name + path of the page that needs changed?

These are the pages that I found during a first run-through that need to be changed:

  • content/en/docs/languages/js/_index.md (adding info about changes to typescript support)
  • content/en/docs/languages/js/exporters.md
  • content/en/docs/languages/js/instrumentation.md
  • content/en/docs/languages/js/serverless.md

Q: I see that there are some pages that also include OTel JS code in examples (like blog posts published some years ago) - should this also be adapted?

Additional context:

@tiffany76
Copy link
Contributor

Thanks for volunteering, @pichlermarc! Your plan sounds reasonable to me, and we can absolutely coordinate the release of the docs changes with the SDK release.

As a general policy, we don't update old blog posts, as they are intended to be snapshots in time. If you find a post that will be "wrong" in its entirety with the new version, we can add an admonition to the post saying that it only applies to versions of the SDK older than 2.0 or something to that effect. But for examples in posts on other topics, we don't make updates.

Labeling looks good!

Thanks again.

@pichlermarc
Copy link
Member Author

Thanks - I opened two PRs already to discontinue use of deprecated API, both target the latest 1.x version 🙂

A draft PR for 2.x changes based on these will follow tomorrow 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants