docs(python): Update Celery integration guide to the Quick Start format - #19055
Open
AmariahAK wants to merge 1 commit into
Open
docs(python): Update Celery integration guide to the Quick Start format#19055AmariahAK wants to merge 1 commit into
AmariahAK wants to merge 1 commit into
Conversation
Co-authored-by: atlarix-agent <agent@atlarix.dev>
|
@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" /> |
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdxuntouched).How it was fixed
## Prerequisites(folded in Celery4.4.7+/ Python3.6+) and removed the## Supported Versionssection and its legacy-SDK include.{
true}>`.
## Installto aSplitLayoutwithpip/uv/poetrytabs.## ConfigurewithOnboardingOptionButtons(error-monitoring,performance, profiling, metrics) and the features expandable; added
### Capturing Errorsand### Instrumenting Your App.## Verify→## Verify Your Setupwith split-layout code samples and a"View Captured Data in Sentry" subsection.
## Optionsbullet list toSdkOptioncomponents.## Next Steps; kept## Distributed Traces(with the protocol v1/v2 note).Why this approach
Self-contained: the guide reuses only includes already on
masterand inlines therest, so it builds cleanly without depending on any unmerged sibling-branch includes.
How to test locally
Run
pnpm devand openhttp://localhost:3000/platforms/python/integrations/celery/ — confirm the numbered
steps, feature toggle buttons, split layouts, and
SdkOptiontables render.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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