Skip to content

docs(python): Update Celery integration guide to the Quick Start format - #19055

Open
AmariahAK wants to merge 5 commits into
getsentry:masterfrom
AmariahAK:master
Open

docs(python): Update Celery integration guide to the Quick Start format#19055
AmariahAK wants to merge 5 commits into
getsentry:masterfrom
AmariahAK:master

Conversation

@AmariahAK

Copy link
Copy Markdown

DESCRIBE YOUR PR

Closes #19036
(part of #18363)

What was the issue

The Celery integration guide (docs/platforms/python/integrations/celery/index.mdx)
still used the legacy "Getting Started" format, while the Python quick start guide
and its sibling guides now use the "Quick Start" format. It was missing a
Prerequisites section, numbered steps, feature toggles, and a Next Steps section.

Where

docs/platforms/python/integrations/celery/index.mdx (single file; crons.mdx untouched).

How it was fixed

  • Added ## Prerequisites (folded in Celery 4.4.7+ / Python 3.6+) and removed the
    ## Supported Versions section and its legacy-SDK include.
  • Wrapped the steps in `<StepConnector selector="h2" showNumbers=

{

true}>`.

  • Converted ## Install to a SplitLayout with pip / uv / poetry tabs.
  • Restructured ## Configure with OnboardingOptionButtons (error-monitoring,
    performance, profiling, metrics) and the features expandable; added
    ### Capturing Errors and ### Instrumenting Your App.
  • Renamed ## Verify## Verify Your Setup with split-layout code samples and a
    "View Captured Data in Sentry" subsection.
  • Converted the ## Options bullet list to SdkOption components.
  • Added ## Next Steps; kept ## Distributed Traces (with the protocol v1/v2 note).

Why this approach

Self-contained: the guide reuses only includes already on master and inlines the
rest, so it builds cleanly without depending on any unmerged sibling-branch includes.

How to test locally

Run pnpm dev and open
http://localhost:3000/platforms/python/integrations/celery/ — confirm the numbered
steps, feature toggle buttons, split layouts, and SdkOption tables render.

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

@vercel

vercel Bot commented Aug 14, 2026

Copy link
Copy Markdown

@AmariahAK is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Comment thread docs/platforms/python/integrations/celery/index.mdx
sfanahata added a commit that referenced this pull request Aug 24, 2026
## DESCRIBE YOUR PR

Automates priority triage and non-blocking reviewer assignment for docs
PRs.

**What changes:**

- Parses the PR urgency section into mutually exclusive Urgent,
Deadline, Needs Triage, or Normal labels.
- Adds one non-blocking reminder comment when a ready PR has missing or
malformed priority metadata, and removes it after correction.
- Requests `getsentry/docs` only for ready, human-authored PRs that are
urgent/deadline-based, external, significant changes under `docs/**`, or
significant changes overall.
- Preserves the existing commented CODEOWNERS specialist assignments
without making Docs or specialists required reviewers.
- Moves external-PR evaluation to trusted `pull_request_target`
workflows with least-privilege tokens and base-SHA validation.
- Removes nine unused, overlapping labels.
- Updates the PR template to require exactly one urgency selection and
ISO `YYYY-MM-DD` deadline dates.

Slack alerts and a daily digest will be added in as a part of this
workflow in a follow-up PR.

## 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+

## TEST PLAN

- `pnpm exec vitest run scripts/docs-pr-triage.test.mjs
scripts/pr-reviewer-assignment.test.mjs
scripts/pr-priority-metadata.test.mjs
scripts/codeowner-workflow.test.mjs
scripts/priority-metadata-workflow.test.mjs` (114 focused tests)
- `pnpm test:ci` (346 tests)
- Targeted ESLint, Prettier, Node syntax, workflow YAML, and `git diff
--check` validation
- Real reviewer dry runs against PRs #19031, #19037, #19055, and #19075
- Real metadata dry runs against PRs #19031, #19073, and #19075
- `github-label-sync@2.2.0 --dry-run` verified only four label creations
and nine confirmed zero-use deletions

## 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)

## EXTRA RESOURCES

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

---------

Co-authored-by: Shannon Anahata <shannonanahata@gmail.com>

@inventarSarah inventarSarah left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you!
This looks great overall -- I just added some suggestions to replace content with some new include files that we have and to rearrange a section to improve the content flow.

Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
Comment thread docs/platforms/python/integrations/celery/index.mdx
Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
Comment thread docs/platforms/python/integrations/celery/index.mdx
Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
AmariahAK and others added 2 commits August 25, 2026 09:28
Co-authored-by: atlarix-agent <agent@atlarix.dev>
Co-authored-by: atlarix-agent <agent@atlarix.dev>
Apply all reviewer suggestions:
- Use PlatformContent include for Install
- Add "Initialize the Sentry SDK" heading
- Use shared verify includes (tracing, logs, metrics)
- Fix Crons links to /integrations/celery/crons/
- Move Distributed Traces under the Tracing toggle and reformat
- Hide the propagate_traces Distributed Traces link behind the performance toggle
- Drop redundant intro and distributed tracing sentences

Co-authored-by: atlarix-agent <agent@atlarix.dev>
@AmariahAK

Copy link
Copy Markdown
Author

Thanks for the thorough review @inventarSarah! I've applied all your suggestions in 86bc25699:

  • Swapped the inline Install SplitLayout for <PlatformContent includePath="getting-started-install" />.
  • Added the ### Initialize the Sentry SDK heading.
  • Removed the redundant "In addition to capturing errors…" sentence.
  • Replaced the three verify sections with the shared include files (tracing / logs / metrics).
  • Fixed both Crons links to /integrations/celery/crons/.
  • Moved ## Distributed Traces up into ### Instrumenting Your App as #### Distributed Traces (SplitLayout, note → Alert, 4.x callout → warning level) and removed the old bottom section.
  • Wrapped the propagate_traces "See Distributed Traces" link in <OnboardingOption optionId="performance">.
  • Dropped the stray intro sentence.

Ready for another look whenever you get a chance — thank you!

Comment thread docs/platforms/python/integrations/celery/index.mdx Outdated
@inventarSarah

Copy link
Copy Markdown
Collaborator

@AmariahAK is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@coolguyzone @sentrivana can you please authorize this PR to be deployed on Vercel? 🙏

AmariahAK and others added 2 commits August 25, 2026 17:19
@AmariahAK

Copy link
Copy Markdown
Author

@inventarSarah ive done the extra changes, could u kindly take a look?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Celery quick start guide

2 participants