Skip to content

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

Open
AmariahAK wants to merge 1 commit into
getsentry:masterfrom
AmariahAK:master
Open

docs(python): Update Celery integration guide to the Quick Start format#19055
AmariahAK wants to merge 1 commit 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

Co-authored-by: atlarix-agent <agent@atlarix.dev>
@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 on lines +52 to +56
<OnboardingOptionButtons
options={["error-monitoring", "performance", "profiling", "metrics"]}
/>

<Include name="quick-start-features-expandable" />

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.

Bug: The Celery guide advertises "logs" in the features expandable but omits the "logs" option from the onboarding buttons and lacks a verification section for it.
Severity: LOW

Suggested Fix

Add "logs" to the options prop of the OnboardingOptionButtons in the Celery guide. Also, add a corresponding <OnboardingOption optionId="logs"> section with instructions on how to verify that logs are working with Celery, similar to the main Python quick start guide.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/python/integrations/celery/index.mdx#L52-L56

Potential issue: There is a documentation inconsistency in the Celery integration guide.
The `quick-start-features-expandable` component lists "logs" as a supported feature for
Python. However, the `OnboardingOptionButtons` on the same page omits the "logs" option,
and there is no corresponding section to guide users on setting up or verifying logs
with Celery. This can confuse users who see logs advertised but are given no
instructions on how to use them in this context, unlike the main Python guide which
provides this information.

Did we get this right? 👍 / 👎 to inform future reviews.

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

1 participant