feat(kmp): update getting started and add manual setup page #11497
Conversation
Current code snippet example doesn't compile in dart
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 15.21MB (107.55%) ⬆️
ℹ️ *Bundle size includes cached data from a previous commit |
|
@buenaflor the changes are good IMO, just a thought on taking this further - we recently streamlined the getting started pages for the other (main) mobile platforms so that it contains the most relevant steps for new setups and focuses on Install, Configure, Verify. everything else is links to subpages from within the text (as needed) and a Next Steps section at the end. do you think it makes sense to expand this PR to this format? |
|
yep makes sense, I'll adapt this |
| <ConfigKey name="send-default-pii"> | ||
|
|
||
| If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent. | ||
|
|
||
| <Note> | ||
|
|
||
| If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. | ||
|
|
||
| </Note> | ||
|
|
||
| This option is turned off by default. | ||
|
|
||
| If you enable this option, be sure to manually remove what you don't want to send using our features for managing [_Sensitive Data_](../../data-management/sensitive-data/). | ||
|
|
||
| </ConfigKey> | ||
|
|
||
| <ConfigKey name="server-name"> | ||
|
|
There was a problem hiding this comment.
removing options that are currently not in KMP layer
|
I updated the getting started page to focus on install, configure and verify I've spread out the rest into separate files @kahest |
|
|
||
| Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page. | ||
|
|
||
| ### Cocoa SDK Version Compatibility Table |
There was a problem hiding this comment.
I think we discussed where to put this info, but I forgot where we landed on - did we plan to put it into the repo's README and link to it from here? or don't we need this info anymore?
There was a problem hiding this comment.
https://github.com/getsentry/sentry-kotlin-multiplatform/pull/290/files
yes, we'll add it to the gh repo as it's easier to manage there.
It's still relevant for people who do the setup without the gradle plugin
There was a problem hiding this comment.
I have some language tweaks, otherwise it looks good. The only thing I'm wondering about is whether it makes sense to move configuration options so much further down. I guess the question is, how important are configuration options for new users versus the folders we're putting above them. In the JS SDKs we actually made the decision to move "Configurations" up b/c people thought they were pretty important... I don't have an answer, just wanted to throw the question out there :)
docs/platforms/kotlin-multiplatform/initialization-strategies.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/kotlin-multiplatform/initialization-strategies.mdx
Outdated
Show resolved
Hide resolved
platform-includes/getting-started-install/kotlin-multiplatform.mdx
Outdated
Show resolved
Hide resolved
|
This pull request has gone three weeks without activity. In another week, I will close it. But! If you comment or otherwise update it, I will reset the clock, and if you add the label "A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀 |
Co-authored-by: Liza Mock <liza.mock@sentry.io>
in most case they're not, this setup is supposed to install everything automatically and should rarely need a manual change of the configuration (at least that's what I hope) |
Current code snippet example doesn't compile in dart
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES
Current code snippet example doesn't compile in dartCurrent code snippet example doesn't compile in dart