search

getsentry / sentry-docs

Sentry's documentation (and tools to build it)
https://docs.sentry.io
Other
332 stars 1.46k forks source link

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

Open InterstellarStella opened 5 days ago

InterstellarStella commented 5 days ago

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[bot] commented 5 days ago

Assigning to @getsentry/support for routing ⏲️

getsantry[bot] commented 5 days ago

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

philipphofmann commented 5 days ago

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.