Skip to content

Add first onboarding guide to docs #13462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 29, 2025
Merged

Add first onboarding guide to docs #13462

merged 9 commits into from
Apr 29, 2025

Conversation

coolguyzone
Copy link
Contributor

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.):
  • Other deadline:
  • 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

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

Copy link

vercel bot commented Apr 21, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 29, 2025 9:43pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Apr 29, 2025 9:43pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Apr 29, 2025 9:43pm

Copy link

codecov bot commented Apr 21, 2025

Bundle Report

Changes will increase total bundle size by 306 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.14MB 312 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.47MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
static/9QEYD91LNIVJddM1WjWhC/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/9QEYD91LNIVJddM1WjWhC/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/1PPaj-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
static/1PPaj-*.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
../app/[[...path]]/page.js.nft.json 107 bytes 388.6kB 0.03%
../app/platform-redirect/page.js.nft.json 107 bytes 388.51kB 0.03%
../app/sitemap.xml/route.js.nft.json 107 bytes 386.48kB 0.03%


## Step 3: integrations

[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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Source Code Management]() <-- Currently linking to the top of the quick-start guide page we're on.


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/)).

## Step 3: integrations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section feels a little passive. As I read through, I see these as options, but my sense is that we want to tell a story about why to do these 3 configurations.

  1. Use a proactive tone, more like - Integrate your SCM for quick issue resolution; Set up notifications to keep people in the know; Automatically create issues to help your team take action
  2. Could a summary of this section right below the title also help? "here are the top integrations to get your team resolving issues faster and more efficiently"

![Auto Resolve Settings Screenshot](./img/auto-resolve.png)


By following this guide, you should have Sentry projects created, your integrations set up, and be configured for SSO/SCIM. For further customization, explore the official Sentry Documentation or [ask Sentry AI](https://sentry.zendesk.com/hc/en-us?askAI=tru).
Copy link
Contributor

@sfanahata sfanahata Apr 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the FYI I want toward the top. I think you can move this up, and have a simpler conclusion at the bottom. Maybe just:

"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."

Copy link
Contributor

@sfanahata sfanahata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coolguyzone Still a few bumpy parts in here that I think should be smoothed over before it's merged.

Copy link
Contributor

@sfanahata sfanahata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops! Meant to approve it with the suggested changes.

@coolguyzone coolguyzone merged commit 9c5a9cd into master Apr 29, 2025
11 checks passed
@coolguyzone coolguyzone deleted the ob-initial branch April 29, 2025 22:02
codyde added a commit that referenced this pull request May 1, 2025
* 'master' of https://github.com/getsentry/sentry-docs:
  Add "Data Collected" page for Godot SDK (and more) (#13533)
  Clarify FK docs (#13562)
  Clarify db index docs (#13561)
  Remove non-functioning video embed (#13557)
  Masinette integrations elba (#13503)
  Incorporate Uptime Monitors Into The Crons Management Page (#13507)
  feat(javascript): Add "Data Collected" (#13527)
  docs(relay): remove entries that are not scrubbed by default (#13555)
  flutter: Add note to app start integration (#13479)
  ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
  docs(python): add uv option to python install instructions (#13510)
  add docs for supabase integration (#13545)
  feat(native): add view hierarchy to develop docs (#13544)
  feat(autofix): Update autofix images (#13540)
  Ad alerts and dashboard page to new quickstart guide (#13522)
  Add data enrichment page to new onboarding guide (#13508)
  Add first onboarding guide to docs (#13462)
  (feat) Sentry MCP Documentation  (#13524)
  feat(Capacitor): Migration guides for version 2 (#13022)
  docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actions github-actions bot locked and limited conversation to collaborators May 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants