Skip to content

feat(docs): Apply new quick start template to Python quick start guides - #19982

Merged
sfanahata merged 8 commits into
masterfrom
docs/quickstart-template-python
Oct 28, 2026
Merged

sfanahata merged 8 commits into
masterfrom
docs/quickstart-template-python

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Applies the quick start template from #19295 (Ember) to the Python quick start and the Django, Flask, FastAPI, Starlette, and Celery quick starts.

  • Removes the onboarding option checkboxes and ___PRODUCT_OPTION___ markers.
  • Configure names the features each guide sets up: Error Monitoring, Logs, Application Metrics, Tracing, and Profiling. The init snippets include Tracing and Profiling by default, and a note explains that unwanted options can be removed.
  • Adds Send Logs and Send Application Metrics as their own steps. sentry_sdk.logger and sentry_sdk.metrics work without extra options. Send Logs explains that stdlib logging and Loguru records need capture_sentry_logs=True on their integrations, and links to both.
  • Framework-specific configuration (capturing errors, instrumentation) stays in Configure. Verify is reduced to one minimal error trigger per framework.
  • Removes "(Optional)" from headings and trims Next Steps.

The shared Python init include is reused by other pages, so FastAPI, Flask, and Starlette now inline their snippets instead of editing it.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • 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

via shannon.anahata.

--

View Junior Session [Sentry]

sentry-junior Bot and others added 2 commits October 14, 2026 21:40
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@vercel

vercel Bot commented Oct 14, 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 Oct 26, 2026 6:42pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 26, 2026 6:42pm UTC

Request Review

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 14, 2026 21:49
@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 14, 2026
@cursor

cursor Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Checks were inconclusive · Rollout details

Status Service Environment
❔ Inconclusive so far sentry-docs production

The check did not reach a verdict. Mention @rollout in a comment to update the plan, or wait for the next deploy.

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
sfanahata added a commit that referenced this pull request Oct 19, 2026
…20017)

## DESCRIBE YOUR PR

Removes the `SplitLayout` component everywhere. Pages that used it now
render their text and code as regular docs content, with the standard
docs spacing.

- Removes the `<SplitLayout>`, `<SplitSection>`, `<SplitSectionText>`,
and `<SplitSectionCode>` wrapper lines from all 169 MDX files that used
them, including the quick start guides. Only the tag lines and the blank
lines around them change. Parsing each file before and after shows the
same content once the wrappers are ignored.
- Deletes `src/components/splitLayout/` and its registration in
`src/mdxComponents.ts`.
- Drops the SplitLayout guidance from
`.claude/skills/technical-docs/SKILL.md`.

Step numbering is unaffected. `StepConnector` finds its `h2` headings
with a descendant selector, so it doesn't depend on these wrappers.

This replaces #19984, which made SplitLayout render as a single column.

### Merge order

Merge this **first**. After it merges, the quick start template PRs that
also edit these files (#19980 Ruby, #19981 Dart and Flutter, #19982
Python, #19983 JavaScript) will need `master` merged in. Those conflicts
are limited to the removed wrapper tags.

## IS YOUR CHANGE URGENT?

- [ ] Urgent deadline (GA date, etc.): YYYY-MM-DD
- [ ] Other deadline: YYYY-MM-DD
- [x] No deadline: Not urgent, can wait up to 1 week+

## PRE-MERGE CHECKLIST

- [ ] 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)

<!-- junior-request-attribution:start -->
via **shannon.anahata**.
<!-- junior-request-attribution:end -->

<!-- junior-session-footer:start -->
<!-- junior-conversation-id:slack%3AD0BB8KQT6MU%3A1792013336.218129 -->

--

[View Junior
Session](https://junior-prod.sentry.dev/conversations/slack%3AD0BB8KQT6MU%3A1792013336.218129)
[[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AD0BB8KQT6MU%3A1792013336.218129/?project=4510944073809921)

<!-- junior-session-footer:end -->

---------

Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
Co-authored-by: Shannon Anahata <shannon.anahata@sentry.io>
Resolve conflicts from #20017 (SplitLayout removal): keep this branch's
content without the removed wrapper tags, and keep master's other
changes to the same files.

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
Shannon Anahata added 3 commits October 26, 2026 11:32
- Replace deprecated send_default_pii with data_collection (matches master)
- Add AsyncioIntegration to the async example; it isn't enabled by default
- State sentry-sdk 2.70.0+ requirement and Python 3.6+ prerequisite
- Verify step now sends a trace, log, and metric alongside the error
- Clarify when profiles are collected and sent
…plate-python-review

# Conflicts:
#	docs/platforms/python/index.mdx
#	docs/platforms/python/integrations/celery/index.mdx
#	docs/platforms/python/integrations/django/index.mdx
- Replace deprecated send_default_pii with data_collection in Flask,
  FastAPI, and Starlette init snippets (user_info), matching master
- List data_collection in each guide's 'snippet also turns on' section
- State sentry-sdk 2.70.0+ requirement under Install
- Clarify that profiles are collected while a transaction is active
sfanahata added a commit that referenced this pull request Oct 27, 2026
…0235)

## DESCRIBE YOUR PR

Updates three feature descriptions in the shared `FeatureInfo` component
(`src/components/featureInfo.tsx`) so they're accurate on every platform
that uses them. The component renders the "Want to learn more about
these features?" and "Need help locating captured data in your Sentry
project?" expandables on the JavaScript, Python, Dart/Flutter, and Ruby
quick starts, plus React Native on its quick start template branch.

**Issues description**
- Before: "...automatically reports errors, uncaught exceptions, and
unhandled rejections."
- After: "...automatically reports errors, uncaught exceptions, and
crashes."
- "Unhandled rejections" is JavaScript-specific (promise rejections). It
shows on every page that lists Issues, including Python, Ruby, and Dart,
where it doesn't apply.
- The old text didn't mention crashes. Native crashes are a core part of
error monitoring on React Native, Flutter, Electron, and Capacitor.

**Session Replay description**
- Before: "...a video-like reproduction of what was happening in the
user's browser..." linking to `/product/session-replay/web`
- After: "...a video-like reproduction of what users saw in your app..."
linking to `/product/session-replay/`
- Session Replay also records mobile app screens (Flutter on master,
React Native on its template branch), so "browser" and the web-only link
were inaccurate there. The overview page covers both web and mobile
replay.

**Profiles navigation**
- Before: "Open the Profiles page, select a transaction, and then a
profile ID to view its flame graph."
- After: "Open the Profiles page to see your slowest functions and an
aggregate flame graph of your most frequent code paths. If tracing is
enabled, select a transaction to see the flame graph for that part of
your app."
- The old steps describe transaction-based profiling. Python and the
JavaScript server SDKs now use continuous profiling, and the
browser-based guides (Astro, React Router, Remix) use
`profileSessionSampleRate`. Selecting a transaction opens an aggregate
flame graph rather than a list of profile IDs, as described in
[Profiling
Page](https://docs.sentry.io/product/profiling/#profiling-page).
- The new wording works for both profiling types. Ruby still uses
transaction-based profiling. Platform-specific details stay on each
platform's profiling pages, and the existing Profile Details link is
unchanged.

Where to see it (all are in collapsed expandables):
- Issues and Session Replay:
https://docs.sentry.io/platforms/javascript/guides/react/ under
Configure → "Want to learn more about these features?" (Python's page
doesn't list Session Replay)
- Profiles:
https://docs.sentry.io/platforms/python/#view-captured-data-in-sentry →
"Need help locating captured data in your Sentry project?"

Related: #19982

## IS YOUR CHANGE URGENT?

- [ ] Urgent deadline (GA date, etc.): YYYY-MM-DD
- [ ] Other deadline: YYYY-MM-DD
- [x] No deadline: Not urgent, can wait up to 1 week+

## PRE-MERGE CHECKLIST

- [ ] 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)

---------

Co-authored-by: Shannon Anahata <shannonanahata@gmail.com>
@sfanahata
sfanahata merged commit acf05fa into master Oct 28, 2026
25 checks passed
@sfanahata
sfanahata deleted the docs/quickstart-template-python branch October 28, 2026 23:40

This branch was successfully deployed

2 active (1 outdated) deployments
Preview – sentry-docs — 64bf080d Deployed Oct 26, 2026 by vercel[bot]
Preview – develop-docs — 48581733 Deployed Oct 19, 2026 by vercel[bot]
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.

2 participants