You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
removing use of deprecated APIs (can be merged immediately as the replacements for these are already present in the latest release)
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?
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.
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 at1.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:
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:
bug
since it's not a bug 🙂)The text was updated successfully, but these errors were encountered: