Skip to content

docs(tracer): add ESM instructions to tracer usage docs #2630

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

Merged
merged 3 commits into from
Jun 11, 2024

Conversation

dreamorosi
Copy link
Contributor

Summary

Changes

Please provide a summary of what's being changed

This PR introduces a section to the "Usage" docs of the Tracer utility to provide instructions on how to use the utility with ESM.

The section attempts to clarify why this is needed and provides code snippets on how to provide a polyfill similar to what done in the upgrade guide.

Below a screenshot of how the section will look like:

image

Note

The code snippets container is collapsed by default in an effort to declutter the page:

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #2623


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Jun 10, 2024
@dreamorosi dreamorosi requested a review from a team June 10, 2024 16:04
@dreamorosi dreamorosi requested a review from a team as a code owner June 10, 2024 16:04
@dreamorosi dreamorosi linked an issue Jun 10, 2024 that may be closed by this pull request
1 task
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Jun 10, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 10, 2024
@dreamorosi dreamorosi requested a review from heitorlessa June 10, 2024 16:04
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@heitorlessa heitorlessa merged commit e894c7e into main Jun 11, 2024
11 checks passed
@heitorlessa heitorlessa deleted the 2623-docs-add-esm-instructions-in-tracer-docs branch June 11, 2024 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add ESM instructions in Tracer docs
3 participants