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

feat(js): Add skipBrowserExtensionCheck documentation #11693

Merged
merged 4 commits into from
Nov 7, 2024

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Oct 31, 2024

DESCRIBE YOUR PR

This PR adds documentation for a new SDK option introduced in getsentry/sentry-javascript#14147

(to be merged once this option is released)

Further small changes:

  • slightly adjusted wording in some paragraphs
  • added more headings for better doc structure (table of contents looked bit weird before)
  • Changed <Note> to <Alert level="danger"> to highlight the implications of using Sentry.init in shared environments

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Copy link

vercel bot commented Oct 31, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2024 0:16am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2024 0:16am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 7, 2024 0:16am

"GlobalHandlers",
].includes(defaultIntegration.name);
return !["BrowserApiErrors", "Breadcrumbs", "GlobalHandlers"].includes(
defaultIntegration.name
Copy link
Member Author

Choose a reason for hiding this comment

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

auto format kicked in here

@Lms24 Lms24 self-assigned this Oct 31, 2024
@Lms24 Lms24 marked this pull request as ready for review October 31, 2024 10:10
@Lms24 Lms24 requested a review from s1gr1d October 31, 2024 10:10
Copy link

codecov bot commented Oct 31, 2024

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 7.38MB 6 bytes (-0.0%) ⬇️
sentry-docs-edge-server-array-push 333.11kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.44MB 6 bytes (-0.0%) ⬇️

</Alert>

This option is purely meant as an escape hatch if our browser extension check is incorrectly detecting a browser extension.
An example for this might be a
Copy link
Member

Choose a reason for hiding this comment

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

I think there is something missing

Copy link
Member Author

Choose a reason for hiding this comment

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

lol good catch, thx :) Finished the sentence now

@@ -130,4 +130,4 @@ You'd risk quota increases with unactionable issues, interference with other Sen
</Alert>

This option is purely meant as an escape hatch if our browser extension check is incorrectly detecting a browser extension.
An example for this might be a
An example for this might be a cross-platform application framework that exposes similar global APIs like browser a browser extension environment.
Copy link
Member

Choose a reason for hiding this comment

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

Something is off here or am I missing something? 🤔
"like browser a browser extension"

Copy link
Member Author

Choose a reason for hiding this comment

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

oof you're right, fixed it now hopefully :)

Copy link
Collaborator

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for updating! Added a couple of suggestions, looks good to go!

@Lms24 Lms24 enabled auto-merge (squash) November 7, 2024 12:00
@Lms24 Lms24 merged commit 35f8a2f into master Nov 7, 2024
11 checks passed
@Lms24 Lms24 deleted the lms/feat-js-add-skipBrowserExtensionCheck-docs branch November 7, 2024 12:16
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