Skip to content

Commit 8445e96

Browse files
sfanahataShannon Anahata
andauthored
Fixed all the broken links to options after SDKoption change (#15237)
## DESCRIBE YOUR PR Fixed all the broken hyperlinks since converting to SDKoption. This broke links to anchors, since the formatting for the anchors is now the actual platform casing (vs all kebab). **Java Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/java/configuration/options/#sendDefaultPii https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/java/configuration/options/#enableBackpressureHandling https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/java/configuration/options/#propagateTraceparent https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/java/configuration/options/#beforeSend https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/java/configuration/options/#sendClientReports https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/java/configuration/options/#maxRequestBodySize **Android Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/android/configuration/options/#beforeSend https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/android/configuration/options/#propagateTraceparent https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/android/configuration/options/#proxy https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/android/configuration/options/#idleTimeout https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/android/configuration/options/#deadlineTimeout https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/android/configuration/options/#sendDefaultPii https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/android/configuration/options/#maxRequestBodySize **.NET Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/dotnet/guides/aspnet/configuration/options/#MaxRequestBodySize https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/dotnet/configuration/options/#SendDefaultPii **Unity Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/unity/configuration/options/#InitCacheFlushTimeout **Unreal Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/unreal/configuration/options/#SendDefaultPii **PowerShell Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/powershell/configuration/options/#SendDefaultPii **React Native Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/react-native/configuration/options/#sendDefaultPii **Dart Common Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/dart/configuration/options/#sendDefaultPii https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/dart/configuration/options/#maxRequestBodySize **Dart/Flutter Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/dart/guides/flutter/configuration/options/#sendDefaultPii https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/dart/guides/flutter/configuration/options/#maxRequestBodySize **Apple Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/apple/guides/ios/configuration/options/#idleTimeout https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/apple/configuration/options/#enablePersistingTracesWhenCrashing https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/apple/configuration/options/#inAppInclude https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/apple/configuration/options/#inAppExclude https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/apple/configuration/options/#sendDefaultPii **Python Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/python/configuration/options/#send_default_pii **PHP Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/php/configuration/options/#send_default_pii https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/php/configuration/options/#max_request_body_size https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/php/configuration/options/#context_lines **Rust Platform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/rust/configuration/options/#send_default_pii https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/rust/configuration/options/#max_request_body_size **Kotlin Multiplatform** https://sentry-docs-git-sdkoption-link-fixes.sentry.dev/platforms/kotlin/guides/kotlin-multiplatform/configuration/options/#sendDefaultPii ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [x] Urgent deadline (GA date, etc.): Ideally today, since these links are broken. - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] None: Not urgent, can wait up to 1 week+ ## 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](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <[email protected]>
1 parent 1ad61e4 commit 8445e96

File tree

34 files changed

+44
-44
lines changed

34 files changed

+44
-44
lines changed

docs/platforms/android/data-management/data-collected.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Sentry takes data privacy very seriously and has default settings in place that
88

99
The category types and amount of data collected vary, depending on the integrations you've enabled in the Sentry SDK. This page lists data categories that the Sentry Android SDK collects.
1010

11-
Many of the categories listed here require you to enable the <PlatformLink to="/configuration/options/#send-default-pii">sendDefaultPii option</PlatformLink>.
11+
Many of the categories listed here require you to enable the <PlatformLink to="/configuration/options/#sendDefaultPii">sendDefaultPii option</PlatformLink>.
1212

1313
## HTTP Headers
1414

1515
By default, the Sentry SDK doesn't send any headers for outgoing HTTP request. Even when sending HTTP headers is enabled, we have a [denylist](https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/util/HttpUtils.java#L21-L34) in place, which filters out any headers that contain sensitive data.
1616

17-
To start sending HTTP headers, set <PlatformLink to="/configuration/options/#send-default-pii">`sendDefaultPii=true`</PlatformLink>.
17+
To start sending HTTP headers, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii=true`</PlatformLink>.
1818

1919
## Cookies
2020

@@ -48,7 +48,7 @@ The request body of incoming HTTP requests can be sent to Sentry. Whether it's s
4848

4949
- **The type of the request body:**
5050
- JSON and form bodies are sent
51-
- **The size of the request body:** There's a <PlatformLink to="/configuration/options/#max-request-body-size">maxRequestBodySize</PlatformLink> option that's set to `NONE` by default. This means by default no request body is sent to Sentry.
51+
- **The size of the request body:** There's a <PlatformLink to="/configuration/options/#maxRequestBodySize">maxRequestBodySize</PlatformLink> option that's set to `NONE` by default. This means by default no request body is sent to Sentry.
5252

5353
## Source Context
5454

docs/platforms/android/data-management/sensitive-data/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ If you are using Sentry in your mobile app, read our [frequently asked questions
3333

3434
## Personally Identifiable Information (PII)
3535

36-
Our newer SDKs do not purposefully send PII to stay on the safe side. This behavior is controlled by an option called [`send-default-pii`](../../configuration/options/#send-default-pii).
36+
Our newer SDKs do not purposefully send PII to stay on the safe side. This behavior is controlled by an option called [`send-default-pii`](../../configuration/options/#sendDefaultPii).
3737

3838
Turning this option on is required for certain features in Sentry to work, but also means you will need to be even more careful about what data is being sent to Sentry (using the options below).
3939

docs/platforms/android/integrations/jetpack-compose/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ NavHost(
234234
}
235235
```
236236

237-
By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished. You can customize the timeout to your needs.
237+
By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished. You can customize the timeout to your needs.
238238

239239
### Verify
240240

docs/platforms/android/integrations/navigation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ protected void onPause() {
7070
}
7171
```
7272

73-
By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished. You can customize the timeout to your needs.
73+
By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished. You can customize the timeout to your needs.
7474

7575
## Verify
7676

docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ plugins {
338338

339339
#### Transaction Lifetime
340340

341-
The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished, or after it reaches the specified [deadlineTimeout](/platforms/android/configuration/options/#deadline-timeout), even if child spans are still running.
341+
The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished, or after it reaches the specified [deadlineTimeout](/platforms/android/configuration/options/#deadlineTimeout), even if child spans are still running.
342342

343343
The `idleTimeout` defaults to `3000` milliseconds (three seconds), and the `deadlineTimeout` defaults to `30000` milliseconds (thirty seconds). You can also disable the idle timeout and deadline timeout by setting them to `null`, but the transaction must be finished manually in this case.
344344

docs/platforms/android/tracing/trace-propagation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ SentryAndroid.init(context, { options ->
6868

6969
Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](https://develop.sentry.dev/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard.
7070

71-
To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/android/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one.
71+
To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/android/configuration/options/#propagateTraceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one.

docs/platforms/android/user-feedback/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The User Feedback widget integrates seamlessly with Session Replay. When the wid
7676

7777
The User Feedback API allows you to collect user feedback while using your own UI components. You can submit feedback directly using the `Sentry.captureFeedback(Feedback)` method.
7878

79-
Sentry can optionally pair this feedback with an event, giving you additional insight into issues. Sentry needs the `eventId` to be able to associate the user feedback to the corresponding event. For example, to get the `eventId`, you can use <PlatformLink to="/configuration/options/#before-send">beforeSend</PlatformLink>, or the return value of the method capturing an event.
79+
Sentry can optionally pair this feedback with an event, giving you additional insight into issues. Sentry needs the `eventId` to be able to associate the user feedback to the corresponding event. For example, to get the `eventId`, you can use <PlatformLink to="/configuration/options/#beforeSend">beforeSend</PlatformLink>, or the return value of the method capturing an event.
8080

8181

8282
```java

docs/platforms/apple/common/data-management/data-collected.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The <PlatformLink to="/configuration/http-client-errors">HTTP Client Errors</Pla
2424

2525
By default, the Sentry SDK doesn't send the user's IP address. Once enabled, the Sentry backend services will infer the user ip address based on the incoming request, unless certain integrations you can enable override this behavior.
2626

27-
To enable sending the user's IP address, set <PlatformLink to="/configuration/options/#send-default-pii">`sendDefaultPii=true`</PlatformLink>.
27+
To enable sending the user's IP address, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii=true`</PlatformLink>.
2828

2929
## Request URL
3030

docs/platforms/apple/common/features/experimental-features.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Do you want to try some new experimental features? On the latest version of the
1919
- Enable <PlatformLink to="/configuration/app-hangs/#app-hangs-v2">AppHangsV2</PlatformLink> to get more detailed app hangs. This differentiates between fully-blocking and non-fully-blocking app hangs, and also tells you the duration of app hangs.
2020
</PlatformSection>
2121
- If you use Swift concurrency, stitch together stack traces of your async code with the `swiftAsyncStacktraces` option. Note that you can enable this in your Objective-C project, but only async code written in Swift will be stitched together.
22-
- Enable the <PlatformLink to="/configuration/options/#enable-persisting-traces-when-crashing">`enablePersistingTracesWhenCrashing`</PlatformLink> option to link ongoing transactions to a crash event when your app crashes.
22+
- Enable the <PlatformLink to="/configuration/options/#enablePersistingTracesWhenCrashing">`enablePersistingTracesWhenCrashing`</PlatformLink> option to link ongoing transactions to a crash event when your app crashes.
2323
- Enable the `enableUnhandledCPPExceptionsV2` option to capture fatal CPPExceptions via hooking into `cxa_throw`
2424

2525
Let us know if you have feedback through [GitHub issues](https://github.com/getsentry/sentry-cocoa/issues).

docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ SentrySDK.start { options in
409409
}];
410410
```
411411
412-
The SDK composes the transaction name out of the host `UIViewController` and the method that the `UIView` is calling; for example, `YourApp_LoginUIViewController.loginButton`. The SDK sets the transaction operation to `ui.action`. If the SDK detects the interaction's origin was a click, it adds `click` as a suffix to the operation. The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds).
412+
The SDK composes the transaction name out of the host `UIViewController` and the method that the `UIView` is calling; for example, `YourApp_LoginUIViewController.loginButton`. The SDK sets the transaction operation to `ui.action`. If the SDK detects the interaction's origin was a click, it adds `click` as a suffix to the operation. The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/apple/guides/ios/configuration/options/#idleTimeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds).
413413
414414
<Alert>
415415

0 commit comments

Comments
 (0)