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.

Sign up for GitHub

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

Jump to bottom

Highlight better the effects of the "include sources" option #11810

Open
InterstellarStella opened this issue Nov 13, 2024 · 3 comments · May be fixed by #11819
Open

Highlight better the effects of the "include sources" option #11810

InterstellarStella opened this issue Nov 13, 2024 · 3 comments · May be fixed by #11819
Labels
Platform: Cocoa Product Area: Docs SDKs Type: Content

Comments

@InterstellarStella
Copy link
Contributor

SDK

Apple SDK

Description

Looking at this page, the "include sources" option is added in the code snippets. There is a description for what this option does on the text above, but a customer believes it does not sufficiently describe its effects, namely, that it will show readable source code in the stack traces.

The accidental inclusion of this option can lead to legal issues on the customer's side.

Suggested Solution

Describe more clearly, with a warning, that this this option will show readable source code in the event's stack traces. Additionally, include a comment that indicates this in the code snippets so people are aware when copying the code snippets without reading the text around them.

Alternatively, make the "include sources" option opt-in instead of opt-out.
@getsantry
Copy link
Contributor

getsantry bot commented Nov 13, 2024

Assigning to @getsentry/support for routing ⏲️

@getsantry getsantry bot moved this to Waiting for: Support in GitHub Issues with 👀 3 Nov 13, 2024
@getsantry
Copy link
Contributor

getsantry bot commented Nov 13, 2024

Routing to @getsentry/product-owners-docs for triage ⏲️

@getsantry getsantry bot moved this from Waiting for: Support to Waiting for: Product Owner in GitHub Issues with 👀 3 Nov 13, 2024
@philipphofmann
Copy link
Member

We can do dynamic code snippets as we have it for https://docs.sentry.io/platforms/javascript/guides/react/#install

Image

Source context could be an extra option disabled per default.

@brustolin brustolin linked a pull request Nov 14, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Platform: Cocoa Product Area: Docs SDKs Type: Content
Projects
GitHub Issues with 👀 3
Status: No status
Mobile & Cross Platform SDK
Status: Needs Discussion
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(apple): Add onboarding source context Option getsentry/sentry-docs
2 participants
@philipphofmann @InterstellarStella