sentry-docs
sentry-docs copied to clipboard
getsentry
Mention Xcode 13+ plist issue in iOS onboarding
Problem Statement
In the onboarding instructions for iOS, we link to our docs for symbol uploads:
After following either of those links, doing the integration, and proceeding with onboarding, anyone using Xcode 13+ will encounter a build breakage (described here: https://github.com/getsentry/sentry-cli/issues/1093)
This issue is actually mentioned on the linked docs pages, but directly above the anchor tags corresponding to those links, such that it is not visible when you navigate to the docs page. It took me some time to discover what the actual issue was, and then a bit longer to realize we had documented it, but in a way that is not really visible to those developers who would need it most: new customers trying out our product for the first time.
What it looks like after following the link to the docs:
You'd have to know to scroll up to see the pertinent warning about Xcode 13+ plists:
Solution Brainstorm
I propose simply adding the same callout blurb to the onboarding instructions themselves, right above the two links "With BitCode" and "Without BitCode".
I agree, adding this blurb on the onboarding instructions makes sense.
Issues with this solution
- The article is paywalled
- The proposed solution is essentially a hack
Are we certain that there's no simpler way to do this?
The link to the article is already in our docs today, I think this is a separate discussion. Whether we keep that link or write our own instructions, this issue was simply to raise the visibility of the issue/solution to avoid people encountering the error when onboarding, or to help them recover from it.
If I'm not mistake, sentry-cli dont need the plist file anymore. I think we can remove the blurb and close this issue.
@philipphofmann @armcknight thoughts?
I think we don't need to provide our own instructions. The link is sufficient, IMO. I'm going to close this. Feel free to reopen it again if you disagree, @brustolin or @armcknight.
Current state
https://docs.sentry.io/platforms/apple/dsym/
