-
Notifications
You must be signed in to change notification settings - Fork 532
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
docs: enhanced description for instrumentations in package.json #2202
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2202 +/- ##
==========================================
- Coverage 90.97% 90.37% -0.61%
==========================================
Files 146 147 +1
Lines 7492 7502 +10
Branches 1502 1571 +69
==========================================
- Hits 6816 6780 -36
- Misses 676 722 +46 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this.
All nits below.
plugins/node/opentelemetry-instrumentation-aws-lambda/package.json
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-redis-4/package.json
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-restify/package.json
Outdated
Show resolved
Hide resolved
plugins/web/opentelemetry-instrumentation-user-interaction/package.json
Outdated
Show resolved
Hide resolved
Thank you @trentm great suggestions. addressed everything |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few more nits from my end as well, but generally I love this change!
plugins/node/opentelemetry-instrumentation-express/package.json
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-fastify/package.json
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-restify/package.json
Outdated
Show resolved
Hide resolved
a863673
to
deed22f
Compare
There seem to be a lot of variations on what instrumentation packages populate in the "description" field of "package.json". This PR aims to align them all to one format, and rephrase them to be more useful to consume (in my opinion).
Previous texts where trivial, too long, and did not explain well enough the target for each instrumentation. I tried to include a short description on what this instrumentation targets in few words. Please share any improvements suggestions to the texts.
I also added a short section to the GUIDELINES to document to the future us, how this text is recommended to be formatted.