Skip to content

Commit 2b97d40

Browse files
Lms24antonpirker
authored andcommitted
ref(develop/setup-wizards): Update wizard specification (#13849)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR A while ago, we shifted our wizards to be less opinionated about the default SDK setup but to instead ask users about enabling high-level Sentry features. After going through our wizard specification, I realized I forgot to update it to reflect this change. This PR does just that (as well as adjusting wording slightly). cc @codyde since I just shared this page with you 😅 ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] 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) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> 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 - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
1 parent 292d19e commit 2b97d40

File tree

1 file changed

+13
-6
lines changed
  • develop-docs/sdk/expected-features/setup-wizards

1 file changed

+13
-6
lines changed

develop-docs/sdk/expected-features/setup-wizards/index.mdx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,22 @@ For instance:
5353
Related to this, wizards should [check the git status](#1-check-preconditions) of the project and warn users if they're not in a clean state.
5454
This ensures that users can revert the changes easily if something goes wrong.
5555

56-
### Cater to the 80%
56+
### Respect Users' decisions
57+
58+
Wizards should allow users to select the high-level Sentry features (e.g. tracing, replay, profiling) they want to install.
59+
The SDK setup should be minimal, may be opinionated ("whatever makes sense for the platform") but
60+
must respect users' decisions.
5761

58-
Wizards should be opinionated in which SDK options are set and cater to the 80% use case.
59-
The SDK setup doesn't necessarily have to be minimal.
60-
For example, it can include optional but recommended integrations (e.g. session replay or profiling) or options (e.g. sample rates).
62+
Some examples:
63+
- We should not enable a feature that users previously declined (e.g. set `tracesSampleRate` if users previously declined to enable tracing)
64+
- We may set additional options, like the `tunnelRoute` option in Next.Js, but we should ask for consent whenever reasonable. In this example, consent is important because setting this option potentially increases users' traffic and hence their infrastructure bill.
65+
- We may set additional options like `tracePropagationTargets` or `sendDefaultPii` as comments, if we think that these are options users should be aware of.
66+
67+
### Cater to the 80%
6168

6269
Given that most wizards will actively modify code or config files, there is a chance that they might fail or break something.
63-
That's okay and expected as long as we're transparent about it and we tell users upfront that we're touching their files.
64-
We cannot possibly cover all edge cases but we should try to cover the 80% so that typical projects can be set up with the wizard.
70+
That's okay and expected as long as we're transparent about it and we tell users upfront that we're modifying their files.
71+
We cannot possibly cover all edge cases but we should try to cover the 80% so that typical projects can be set up successfully.
6572

6673
### Support Self-Hosted Sentry
6774

0 commit comments

Comments
 (0)