Skip to content

feat(docs): Update quick start guide template - #19295

Draft
inventarSarah wants to merge 3 commits into
masterfrom
smi/play/quick-start/default-features
Draft

feat(docs): Update quick start guide template#19295
inventarSarah wants to merge 3 commits into
masterfrom
smi/play/quick-start/default-features

Conversation

@inventarSarah

@inventarSarah inventarSarah commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Features like Logs and Metrics are (going to be) enabled by default, and users don't need to configure them to use them. We want to include these features in the quick start guides -> up until now, we could add new features via the Onboarding Options, which made sense for features that needed setup. For Logs and Metrics, however, there are no setup steps to present.
-> What is the most effective and user-friendly way to integrate default-enabled features like Logs and Metrics into our quick start guides, given that they require no configuration?

We want to use this draft PR to explore possible solutions with help and feedback from the SDK teams.

For the latest draft, see the Ember guide.

Changes:

  • moved onboarding options down to "Initialize SDK" and updated the description above it to inform about default features
  • filtered out "error-monitoring" so it doesn't show in the onboarding options (just temporary for testing)
  • added 2 new h2 sections for Logs and Metrics
    • I didn't see any logging integrations for JS -> if there were, I'd have added them to this new Logs section
  • removed Logs and Metrics from the Verify section (verify if you've configured things correctly -> logs+metrics are enabled by default; if users want to verify these, they can use the examples provided in the code snippets in the same guide)
  • left logs and metrics in the expendables (Want to learn more; Need help locating data in Sentry)
  • cleaned up next steps (only 3 left -- I think that's a good number)

Reminder: logs still need to be set via enable_logs for some SDKs (eg JavaScript's Electron)

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

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

@vercel

vercel Bot commented Sep 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Sep 10, 2026 7:06am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 10, 2026 7:06am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Sep 8, 2026
Comment thread docs/platforms/javascript/guides/ember/index.mdx Outdated
Comment thread docs/platforms/javascript/guides/ember/index.mdx
Comment thread docs/platforms/javascript/guides/ember/index.mdx Outdated
Comment thread docs/platforms/javascript/guides/ember/index.mdx

@coolguyzone coolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this works with some minor suggested changes. I'll leave the final decision in @sfanahata 's hands.

Comment thread docs/platforms/javascript/guides/ember/index.mdx Outdated
Comment thread docs/platforms/javascript/guides/ember/index.mdx Outdated
Comment on lines 40 to 42

<OnboardingOptionButtons
options={[

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's not the worst experience, but something still feels off about having the error monitoring button greyed out, while excluding logs and app metrics from this list. I wonder if we get rid of the error monitoring button since we share that "
Initializing the Sentry SDK enables core features such as Error Monitoring, Logs, and Application Metrics by default." at the top of the section?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants