Repository navigation
feat(docs): Apply new quick start template to Apple quick start guides - #20004
sentry-junior[bot] wants to merge 3 commits into
Conversation
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
The change rewrites Apple getting-started guides to a numbered setup flow. The plan checks client errors, sampled page volume, and page duration on those guides. An issue escalates when client errors rise or sampled volume falls. Services: Mention PlanWhat changedApple getting-started pages now show a numbered Install, Configure, and Verify flow. They no longer show product-option checkboxes. The iOS page still shows the setup wizard and a manual path. macOS, tvOS, visionOS, and watchOS each show their own SDK snippets. The change is live after sentry-docs deploys. RiskA StepConnector or code-tab failure can hide the setup steps. Readers then cannot copy a working SDK snippet. A wrong platform gate can show iOS-only wizard text on other Apple platforms. Extra snippets can slow the iOS guide. watchOS no longer enables logs in the getting-started snippet. Intended effectThis rewrite does not emit a success counter for the new template. Record intended effect as unknown unless the new heading id appears in traffic. The new heading id is
Absent looks like this: Apple getting-started volume still holds, and Regression watchWatch client errors and sampled traffic on the pages that include this file. Split the volume signal by the iOS path and the macOS path. iOS is the heavy wizard path. Trace volume is sampled at 30 percent. Pair error counts with that sampled volume. Transaction name is
Also read Not observableLCP for these pages returned no value, so first-paint impact is not measurable here. tvOS getting-started had 0 sampled spans in 7d, so that slice has no duration baseline. visionOS and watchOS had 3 sampled spans each in 7d, so those slices cannot support a latency rule. Telemetry cannot show whether each platform rendered the correct snippet. Telemetry cannot show that the product-option checkboxes are gone. |
Document wizard omissions and return readers to the remaining setup steps. Align Apple quickstarts and linked feature, logging, and metrics guidance with the Cocoa SDK, and add tracing, symbol upload, and verification steps.
DESCRIBE YOUR PR
Applies the quick start template from #19295 (Ember) to the shared Apple quick start (
includes/apple-platform-getting-started.mdx), which renders for the iOS, macOS, tvOS, visionOS, and watchOS guides. All pages keep their single-column layout.___PRODUCT_OPTION___markers. iOS keeps the setup wizard and a manual installation path.SentrySDK.loggeron all supported Apple platforms, including watchOS. SDK 9.27+ manual logging doesn't require an enable flag; older SDK setup remains documented. Updates the linked feature, logging integration, and configuration pages to match.Validation
git diff --check; the quickstart and updated setup/options includes pass Prettier. Existing formatting differences in other linked pages were left outside the content changes.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via shannon.anahata.
--
View Junior Session [Sentry]