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(README): clarify browser support #4037

Conversation

pichlermarc
Copy link
Member

Which problem is this PR solving?

Currently, browser support of the packages in this repo is not considered production-ready, we should set expectations in the README.md accordingly.

Fixes #4035
See also open-telemetry/opentelemetry.io#3125

Short description of the changes

Adds a not based on open-telemetry/opentelemetry.io#3125 to the README under Browser Support. Removes the checkmark for Browser Support in the supported runtimes

Type of change

  • docs

@codecov
Copy link

codecov bot commented Aug 4, 2023

Codecov Report

Merging #4037 (dd98238) into main (5fd656b) will increase coverage by 0.34%.
The diff coverage is n/a.

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4037      +/-   ##
==========================================
+ Coverage   92.36%   92.71%   +0.34%     
==========================================
  Files         321      287      -34     
  Lines        9264     8143    -1121     
  Branches     1968     1689     -279     
==========================================
- Hits         8557     7550    -1007     
+ Misses        707      593     -114     

see 62 files with indirect coverage changes

@pichlermarc pichlermarc added document Documentation-related Skip Changelog labels Aug 4, 2023
@pichlermarc pichlermarc marked this pull request as ready for review August 4, 2023 11:14
@pichlermarc pichlermarc requested a review from a team August 4, 2023 11:14
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
pichlermarc and others added 4 commits August 7, 2023 11:23
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

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.

Clarify current state of browser support in the README
4 participants