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

docs: add experimental disclaimers to all experimental packages. #3233

Merged

Conversation

pichlermarc
Copy link
Member

Which problem is this PR solving?

Right now, a package's version is the only indicator that a package is experimental.
This PR adds a note indicating experimental status to each experimental package's README.md.
This way it shows up on npmjs.com

Related #3230

@pichlermarc pichlermarc added document Documentation-related Skip Changelog labels Sep 6, 2022
@pichlermarc pichlermarc requested a review from a team September 6, 2022 08:52
@codecov
Copy link

codecov bot commented Sep 6, 2022

Codecov Report

Merging #3233 (1288774) into main (c926e3d) will decrease coverage by 1.10%.
The diff coverage is n/a.

❗ Current head 1288774 differs from pull request most recent head 950ed28. Consider uploading reports for the commit 950ed28 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3233      +/-   ##
==========================================
- Coverage   93.17%   92.07%   -1.11%     
==========================================
  Files         196       87     -109     
  Lines        6494     2499    -3995     
  Branches     1371      547     -824     
==========================================
- Hits         6051     2301    -3750     
+ Misses        443      198     -245     
Impacted Files Coverage Δ
...s/opentelemetry-core/src/platform/node/sdk-info.ts 0.00% <0.00%> (-100.00%) ⬇️
...opentelemetry-core/src/platform/node/globalThis.ts 0.00% <0.00%> (-100.00%) ⬇️
...pentelemetry-core/src/platform/node/performance.ts 0.00% <0.00%> (-100.00%) ⬇️
...emetry-api-metrics/src/platform/node/globalThis.ts 0.00% <0.00%> (-100.00%) ⬇️
...lemetry-resources/src/detectors/ProcessDetector.ts 31.81% <0.00%> (-68.19%) ⬇️
...perimental/packages/otlp-exporter-base/src/util.ts 79.41% <0.00%> (-17.65%) ⬇️
...ckages/opentelemetry-exporter-zipkin/src/zipkin.ts 84.48% <0.00%> (-15.52%) ⬇️
...lemetry-resources/src/detectors/BrowserDetector.ts 93.33% <0.00%> (-6.67%) ⬇️
...etry-exporter-prometheus/src/PrometheusExporter.ts
...es/opentelemetry-instrumentation-http/src/utils.ts
... and 107 more

@dyladan dyladan merged commit a8047ba into open-telemetry:main Sep 6, 2022
@dyladan dyladan deleted the docs/experimental branch September 6, 2022 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related Skip Changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants