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

Simplify and make js manual doc more correct #1435

Closed

Conversation

cartermp
Copy link
Contributor

@cartermp cartermp commented Jun 10, 2022

Preview: https://deploy-preview-1435--opentelemetry.netlify.app/docs/instrumentation/js/instrumentation/

This change does a few things:

  • Change SimpleSpanProcessor to BatchSpanProcessor. Got some feedback that this code is more likely to be copied into a production app and people probably shouldn't be using SimpleSpanProcessor for that
  • Changes some of the code samples to be a little more clear (I think) in how they're laid out, with simpler code comments
  • Changes other code samples to just have less code - some were combining multiple concepts like creating a child span and showing how to set an attribute, and it's confusing to show both
  • Formats the document to match other doc formatting here

@cartermp cartermp requested a review from a team June 10, 2022 17:20
@cartermp
Copy link
Contributor Author

@open-telemetry/javascript-approvers it looks like you're not listed as code owners for these docs - would you like to be added? I intend on making more docs changes here soon and it'd be good to get your eyes/opinions.

@cartermp
Copy link
Contributor Author

Superseded by #1445 - will pull feedback over

@cartermp cartermp closed this Jun 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants