Skip to content

Commit 9c5a9cd

Browse files
coolguyzoneAlex Krawiecsfanahata
authored
Add first onboarding guide to docs (#13462)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## 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. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] 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) ## 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/) --------- Co-authored-by: Alex Krawiec <[email protected]> Co-authored-by: Shannon Anahata <[email protected]>
1 parent d8d6535 commit 9c5a9cd

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
28.2 KB
Loading

docs/product/onboarding/index.mdx

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Quick-Start Guide
3+
description: "An easy onboarding guide for Sentry."
4+
sidebar_order: 4000
5+
---
6+
7+
By the end of this guide, you'll be able to create and configure projects in Sentry to gain detailed insights into issues, including the exact lines of code affected, the environment in which they occurred, and the releases they originated from. Additionally, we'll walk you through Sentry's most essential integrations and SSO/SCIM configuration. If you get stuck anywhere, please [Ask Sentry AI](https://sentry.zendesk.com/hc/en-us?askAI=true) or join our [Discord](https://discord.gg/sentry) community.
8+
9+
## Step 1: Initial Project Creation and Configuration
10+
By the end of this step, you'll have enabled a few features, mapped data into Sentry, and added important metadata like environments and releases to help you filter.
11+
12+
1. Sentry's in-app project creation workflow allows you to enable Tracing and Session Replay. Check out this [step-by-step walkthrough](https://sentry.io/orgredirect/projects/new/) on creating and configuring a Sentry project within your environment. At a minimum, this will allow you to take advantage of the free allocated Tracing and Session replay quota.
13+
14+
2. The Sentry project creation flow includes a "Source Map Wizard" to help streamline the uploading of your artifacts (source maps, debug information files, symbols).
15+
16+
17+
- Source Maps (JS) and Debug Symbols are crucial for translating minified or obfuscated code back into a human-readable format, allowing you to pinpoint the exact lines of code causing your issues. Here you can find instructions for [JavaScript](/platforms/javascript/sourcemaps/uploading/) as well as [Android](/platforms/android/enhance-errors/source-context/) and [iOS](/platforms/apple/guides/ios/sourcecontext/).
18+
19+
<Arcade src="https://demo.arcade.software/rxKoIgKxfVE5rXhizlEL?embed" />
20+
21+
3. Add [Environments](/concepts/key-terms/environments/) and [Releases](/platform-redirect/?next=/configuration/releases/) to your Sentry init.
22+
23+
24+
- Set up environments (production, staging, etc.) and releases in Sentry to streamline error tracking. Environments filter issues by context, while releasing link errors to code versions for easier debugging.
25+
26+
<Arcade src="https://demo.arcade.software/MKxHyDhuA1edeTqEhESL?embed" />
27+
28+
## Step 2: Get your team on Sentry by implementing SSO or SCIM - For New organizations
29+
30+
31+
To manage user authentication and provisioning, you can configure Single Sign-On ([SSO](/organization/authentication/sso/)) and System for Cross-Domain Identity Management ([SCIM](/organization/authentication/sso/okta-sso/okta-scim/)).
32+
33+
## Step 3: integrations
34+
35+
[Source Code Management](): Integrating your SCM with Sentry is critical for efficient issue resolution. It links code changes to errors, helping you identify and resolve issues quickly. WIth commit tracking and Suspect Commits, users can pinpoint problematic changes and trace them to the relevant stack trace.
36+
37+
<Alert>
38+
SCM (GitHub) integration highlights include:
39+
- [Stack trace linking](/organization/integrations/source-code-mgmt/github/#stack-trace-linking)
40+
- [Highlight suspect commits within an issue detail](/organization/integrations/source-code-mgmt/github/#suspect-commits-and-suggested-assignees)
41+
- [Automatically link code owners](/organization/integrations/source-code-mgmt/github/#code-owners)
42+
43+
<Arcade src="https://demo.arcade.software/qFzrbkftPVGTGLveRedZ?embed" />
44+
</Alert>
45+
46+
[Messaging/Notifications](/organization/integrations/notification-incidents/): A messaging integration will allow you to configure alerts based on issue severity, resolving or ignoring issues directly from Slack, and links back to Sentry for deeper investigation. This keeps teams proactive by instantly alerting them about critical issues.
47+
48+
[Issue Tracking](/organization/integrations/#issue-tracking): Helps teams track and manage Sentry issues within their ticketing system. You will be able to trigger the automatic creations of issues from Sentry events, sync status updates between tools, and link Sentry issues to existing tickets for streamlined resolution.
49+
50+
51+
- Linking Sentry to JIRA keeps issue statuses synced, automatically marking Sentry issues as resolved when appropriate. This ensures that reappearing issues get flagged regressions.
52+
<Arcade src="https://demo.arcade.software/atttrvOjh9g1x9V7c8Z9?embed" />
53+
54+
55+
- To manage stale issues within Sentry, enable auto-resolve for those unseen within a set timeframe. **We recommend setting auto-resolve to 2 weeks** for optimal issue and regression tracking. Configure this in **Project Settings > General Settings > Auto Resolve**.
56+
57+
![Auto Resolve Settings Screenshot](./img/auto-resolve.png)
58+
59+
By making it to the end, you have a great head start on getting the most out of Sentry. For further customization, explore the official Sentry Documentation or [ask Sentry AI](https://sentry.zendesk.com/hc/en-us?askAI=tru).

0 commit comments

Comments
 (0)