docs: update readmes to follow a standard pattern

[pizzaz93]

Covers the node folder portion of the issue in #819.

Fixes #819

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: pizzaz93 / name: Peretz Cohen (ce04623)

[pizzaz93]

Validating the first file commit before propagating the edit to other files, @blumamir feel free to disregard for the moment.

[rauno56]

I can confirm that's the idea of the issue! 👍

The wording has to be adjusted for the web bits.
Please also check if the new wording is correct saying each of the packages are included in the auto-instrumentations-node bundle.

[pizzaz93]

Meaning that the package is listed under the "Supported instrumentations" header?
https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node

What wording would we want for the web folder?

@dyladan @rauno56

[codecov]

Codecov Report

Merging #960 (a395d2e) into main (125c2f7) will decrease coverage by 4.22%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #960      +/-   ##
==========================================
- Coverage   95.91%   91.68%   -4.23%     
==========================================
  Files          13      104      +91     
  Lines         856     5326    +4470     
  Branches      178     1083     +905     
==========================================
+ Hits          821     4883    +4062     
- Misses         35      443     +408     

Impacted Files	Coverage Δ
...entation-aws-sdk/src/services/MessageAttributes.ts	90.32% <0.00%> (ø)
...extension-autoinjection/src/contentScript/index.ts	0.00% <0.00%> (ø)
...de/opentelemetry-instrumentation-hapi/src/utils.ts	100.00% <0.00%> (ø)
...try-instrumentation-restify/src/instrumentation.ts	89.32% <0.00%> (ø)
...pentelemetry-instrumentation-knex/src/constants.ts	100.00% <0.00%> (ø)
...ode/opentelemetry-instrumentation-dns/src/utils.ts	95.91% <0.00%> (ø)
.../opentelemetry-instrumentation-graphql/src/enum.ts	100.00% <0.00%> (ø)
...-instrumentation-nestjs-core/src/enums/NestType.ts	100.00% <0.00%> (ø)
...y-instrumentation-cassandra/src/instrumentation.ts	80.37% <0.00%> (ø)
...telemetry-instrumentation-fastify/src/constants.ts	100.00% <0.00%> (ø)
... and 81 more

[rauno56]

Meaning that the package is listed under the "Supported instrumentations" header? https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node

In the readme, yes, and under dependencies in the package.json.

What wording would we want for the web folder?

What would make sense in your opinion?

[pizzaz93]

fs, tedious, router aren't included in https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node

I don't think I have sufficient context to suggest verbiage for the web folder content edits.

[rauno56]

fs, tedious, router aren't included in https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node

Adding those: #981
Thanks for going over them!

I don't think I have sufficient context to suggest verbiage for the web folder content edits.

I'd use something very analogous:

This module provides automatic instrumentation for [...], which may be loaded using the @opentelemetry/sdk-trace-web package.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-web bundle with @opentelemetry/sdk-trace-web for the most seamless instrumentation experience.

[pizzaz93]

fs, tedious, router aren't included in https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node

Adding those: #981 Thanks for going over them!

I don't think I have sufficient context to suggest verbiage for the web folder content edits.

I'd use something very analogous:

This module provides automatic instrumentation for [...], which may be loaded using the @opentelemetry/sdk-trace-web package.
If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-web bundle with @opentelemetry/sdk-trace-web for the most seamless instrumentation experience.

Thank you @rauno56, I've added the updated readme introduction syntax to the web folder as well. The PR is ready for review at this time.

[rauno56]

Nice! Thanks and congrats for the first contribution!

[pizzaz93]

It's been two months since this PR was first filed, is this stuck on the dependent PR?

[blumamir]

LGTM
Sorry about the delay and thanks for the reminder :)

[pizzaz93]

Thank you @rauno56 and @blumamir.