From 7ca5b18a64a356a9b5b67f4367c52abcf84b3f96 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Mon, 10 Nov 2025 13:58:23 +0100 Subject: [PATCH] ref9onboarding): Split quart onboarding docs --- .../gettingStartedDocs/python/quart/index.tsx | 29 ++++++++++++ .../onboarding.spec.tsx} | 2 +- .../{quart.tsx => quart/onboarding.tsx} | 44 +++---------------- 3 files changed, 37 insertions(+), 38 deletions(-) create mode 100644 static/app/gettingStartedDocs/python/quart/index.tsx rename static/app/gettingStartedDocs/python/{quart.spec.tsx => quart/onboarding.spec.tsx} (98%) rename static/app/gettingStartedDocs/python/{quart.tsx => quart/onboarding.tsx} (76%) diff --git a/static/app/gettingStartedDocs/python/quart/index.tsx b/static/app/gettingStartedDocs/python/quart/index.tsx new file mode 100644 index 00000000000000..36c9febcda9a14 --- /dev/null +++ b/static/app/gettingStartedDocs/python/quart/index.tsx @@ -0,0 +1,29 @@ +import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types'; +import { + feedbackOnboardingJsLoader, + replayOnboardingJsLoader, +} from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader'; +import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring'; +import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport'; +import {featureFlag} from 'sentry/gettingStartedDocs/python/python/featureFlag'; +import {logs} from 'sentry/gettingStartedDocs/python/python/logs'; +import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp'; +import {profiling} from 'sentry/gettingStartedDocs/python/python/profiling'; + +import {onboarding} from './onboarding'; + +const docs: Docs = { + onboarding, + replayOnboardingJsLoader, + profilingOnboarding: profiling({basePackage: 'sentry-sdk[quart]'}), + crashReportOnboarding: crashReport, + featureFlagOnboarding: featureFlag, + feedbackOnboardingJsLoader, + agentMonitoringOnboarding: agentMonitoring, + mcpOnboarding: mcp, + logsOnboarding: logs({ + packageName: 'sentry-sdk[quart]', + }), +}; + +export default docs; diff --git a/static/app/gettingStartedDocs/python/quart.spec.tsx b/static/app/gettingStartedDocs/python/quart/onboarding.spec.tsx similarity index 98% rename from static/app/gettingStartedDocs/python/quart.spec.tsx rename to static/app/gettingStartedDocs/python/quart/onboarding.spec.tsx index 216752b4dc697f..5854c1d45dcfd9 100644 --- a/static/app/gettingStartedDocs/python/quart.spec.tsx +++ b/static/app/gettingStartedDocs/python/quart/onboarding.spec.tsx @@ -4,7 +4,7 @@ import {renderWithOnboardingLayout} from 'sentry-test/onboarding/renderWithOnboa import {screen} from 'sentry-test/reactTestingLibrary'; import {textWithMarkupMatcher} from 'sentry-test/utils'; -import docs from './quart'; +import docs from '.'; describe('quart onboarding docs', () => { it('renders doc correctly', () => { diff --git a/static/app/gettingStartedDocs/python/quart.tsx b/static/app/gettingStartedDocs/python/quart/onboarding.tsx similarity index 76% rename from static/app/gettingStartedDocs/python/quart.tsx rename to static/app/gettingStartedDocs/python/quart/onboarding.tsx index 9c062f6df577b9..9f7b409b1fe581 100644 --- a/static/app/gettingStartedDocs/python/quart.tsx +++ b/static/app/gettingStartedDocs/python/quart/onboarding.tsx @@ -1,29 +1,15 @@ import {ExternalLink} from 'sentry/components/core/link'; import { StepType, - type Docs, type DocsParams, type OnboardingConfig, } from 'sentry/components/onboarding/gettingStartedDoc/types'; -import { - feedbackOnboardingJsLoader, - replayOnboardingJsLoader, -} from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader'; -import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring'; -import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport'; -import {featureFlag} from 'sentry/gettingStartedDocs/python/python/featureFlag'; -import {logs, verify} from 'sentry/gettingStartedDocs/python/python/logs'; -import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp'; -import { - alternativeProfiling, - profiling, -} from 'sentry/gettingStartedDocs/python/python/profiling'; +import {verify} from 'sentry/gettingStartedDocs/python/python/logs'; +import {alternativeProfiling} from 'sentry/gettingStartedDocs/python/python/profiling'; import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils'; import {t, tct} from 'sentry/locale'; -type Params = DocsParams; - -const getSdkSetupSnippet = (params: Params) => ` +const getSdkSetupSnippet = (params: DocsParams) => ` import sentry_sdk from sentry_sdk.integrations.quart import QuartIntegration from quart import Quart @@ -68,7 +54,7 @@ sentry_sdk.init( ) `; -const onboarding: OnboardingConfig = { +export const onboarding: OnboardingConfig = { introduction: () => tct('The Quart integration adds support for the [link:Quart Web Framework].', { link: , @@ -87,7 +73,7 @@ const onboarding: OnboardingConfig = { ], }, ], - configure: (params: Params) => [ + configure: (params: DocsParams) => [ { type: StepType.CONFIGURE, content: [ @@ -109,7 +95,7 @@ app = Quart(__name__) ], }, ], - verify: (params: Params) => [ + verify: (params: DocsParams) => [ { type: StepType.VERIFY, content: [ @@ -153,7 +139,7 @@ app.run() ], }, ], - nextSteps: (params: Params) => { + nextSteps: (params: DocsParams) => { const steps = [] as any[]; if (params.isLogsSelected) { steps.push({ @@ -168,19 +154,3 @@ app.run() return steps; }, }; - -const docs: Docs = { - onboarding, - replayOnboardingJsLoader, - profilingOnboarding: profiling({basePackage: 'sentry-sdk[quart]'}), - crashReportOnboarding: crashReport, - featureFlagOnboarding: featureFlag, - feedbackOnboardingJsLoader, - agentMonitoringOnboarding: agentMonitoring, - mcpOnboarding: mcp, - logsOnboarding: logs({ - packageName: 'sentry-sdk[quart]', - }), -}; - -export default docs;