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

JS Docs: consolidate /api/tracing and /instrumentation #1722

Closed
cartermp opened this issue Sep 7, 2022 · 2 comments
Closed

JS Docs: consolidate /api/tracing and /instrumentation #1722

cartermp opened this issue Sep 7, 2022 · 2 comments

Comments

@cartermp
Copy link
Contributor

cartermp commented Sep 7, 2022

We have some duplicated content in /api/tracing and /instrumentation. The latter is the most up to date, and the former was donated to this repository a while ago.

Both have a lot of views: https://play.honeycomb.io/opentelemetry-web/datasets/opentelemetry.io/result/fGMfroiQT5Z?useStackedGraphs

I propose that we migrate stuff from /api/tracing that's not in /instrumentation over to /instrumentation, remove the /api/tracing page, and then redirect /api/tracing to /instrumentation.

@cartermp cartermp added bug Something isn't working docs e1-hours Effort: < 8 hrs and removed bug Something isn't working labels Sep 7, 2022
@cartermp
Copy link
Contributor Author

cartermp commented Sep 7, 2022

I think that with the information we have in /tracing, this sample in particular could probably be obviated: https://opentelemetry.io/docs/instrumentation/js/api/tracing/#describing-a-span

Although we don't show how to use context.with today, it's a rather advanced way to propagate context and create child spans with startActiveSpan gets the job done.

@cartermp
Copy link
Contributor Author

Closin'

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