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: [Browser] Define the support browser runtimes #4168 #5032

Closed
wants to merge 2 commits into from

Conversation

MSNev
Copy link
Contributor

@MSNev MSNev commented Oct 2, 2024

As part of v2 preparation and defining the based supported set of browser / runtimes.

While defined as a v2 Issue, there is no readme for v2, so adding to core

Issue: #4168 [Browser] Define the support browser runtimes

@MSNev MSNev requested a review from a team as a code owner October 2, 2024 16:27
Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.27%. Comparing base (f8ab559) to head (b6789fc).
Report is 30 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5032      +/-   ##
==========================================
- Coverage   93.39%   93.27%   -0.13%     
==========================================
  Files          46      317     +271     
  Lines         712     8194    +7482     
  Branches      120     1640    +1520     
==========================================
+ Hits          665     7643    +6978     
- Misses         47      551     +504     

see 266 files with indirect coverage changes

Rather that define versions of specific browsers / runtimes, OpenTelemetry sets the minimum supported version based on the
underlying Language features used.

The current minumum language feature support is set as [ECMAScript 2020](https://www.w3schools.com/jS/js_2020.asp) that are available
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if w3schools is the most professional place to link to, not expecting something as thick as the spec but maybe caniuse since MDN doesn't have an equivalent page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dyladan, @pichlermarc Does OpenTelemetry have a specific (official / semi-official) site that we should use for externally referencing language references?

Copy link
Member

Choose a reason for hiding this comment

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

@MSNev I'm not aware of any guidelines regarding that - I think we should use a link to the spec as there's no way to misunderstand what we're talking about. If there's a need for additional links we can still add them later on.

README.md Outdated Show resolved Hide resolved
Co-authored-by: t2t2 <[email protected]>
Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

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

Looks good already, thanks @MSNev 🙂

As you mentioned in the SIG meeting last week, we currently don't have a way to deal with README.md changes for the next branch.

I think rather than merging it into main where this is immediately visible we should create a file on the next branch called README_NEXT.md. Then, when we're ready to release 2.0 we will create a PR to manually merge the README.md from main with README_NEXT.md to get the final output (I'll create an issue so that we don't forget). Since we manually merge the files later, the README_NEXT.md can just contain the browser support statement for now.

Rather that define versions of specific browsers / runtimes, OpenTelemetry sets the minimum supported version based on the
underlying Language features used.

The current minumum language feature support is set as [ECMAScript 2020](https://www.w3schools.com/jS/js_2020.asp) that are available
Copy link
Member

Choose a reason for hiding this comment

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

@MSNev I'm not aware of any guidelines regarding that - I think we should use a link to the spec as there's no way to misunderstand what we're talking about. If there's a need for additional links we can still add them later on.

@MSNev
Copy link
Contributor Author

MSNev commented Oct 9, 2024

Moving to next branch and renaming as suggested

@MSNev MSNev closed this Oct 9, 2024
@MSNev
Copy link
Contributor Author

MSNev commented Oct 9, 2024

replaced by #5059

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.

3 participants