Skip to content

Commit 2cdfbdd

Browse files
ref(onboarding): Split quart onboarding docs (#103052)
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms
1 parent 51244d9 commit 2cdfbdd

File tree

3 files changed

+37
-38
lines changed

3 files changed

+37
-38
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types';
2+
import {
3+
feedbackOnboardingJsLoader,
4+
replayOnboardingJsLoader,
5+
} from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
6+
import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
7+
import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
8+
import {featureFlag} from 'sentry/gettingStartedDocs/python/python/featureFlag';
9+
import {logs} from 'sentry/gettingStartedDocs/python/python/logs';
10+
import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp';
11+
import {profiling} from 'sentry/gettingStartedDocs/python/python/profiling';
12+
13+
import {onboarding} from './onboarding';
14+
15+
const docs: Docs = {
16+
onboarding,
17+
replayOnboardingJsLoader,
18+
profilingOnboarding: profiling({basePackage: 'sentry-sdk[quart]'}),
19+
crashReportOnboarding: crashReport,
20+
featureFlagOnboarding: featureFlag,
21+
feedbackOnboardingJsLoader,
22+
agentMonitoringOnboarding: agentMonitoring,
23+
mcpOnboarding: mcp,
24+
logsOnboarding: logs({
25+
packageName: 'sentry-sdk[quart]',
26+
}),
27+
};
28+
29+
export default docs;

static/app/gettingStartedDocs/python/quart.spec.tsx renamed to static/app/gettingStartedDocs/python/quart/onboarding.spec.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {renderWithOnboardingLayout} from 'sentry-test/onboarding/renderWithOnboa
44
import {screen} from 'sentry-test/reactTestingLibrary';
55
import {textWithMarkupMatcher} from 'sentry-test/utils';
66

7-
import docs from './quart';
7+
import docs from '.';
88

99
describe('quart onboarding docs', () => {
1010
it('renders doc correctly', () => {

static/app/gettingStartedDocs/python/quart.tsx renamed to static/app/gettingStartedDocs/python/quart/onboarding.tsx

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,15 @@
11
import {ExternalLink} from 'sentry/components/core/link';
22
import {
33
StepType,
4-
type Docs,
54
type DocsParams,
65
type OnboardingConfig,
76
} from 'sentry/components/onboarding/gettingStartedDoc/types';
8-
import {
9-
feedbackOnboardingJsLoader,
10-
replayOnboardingJsLoader,
11-
} from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
12-
import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
13-
import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
14-
import {featureFlag} from 'sentry/gettingStartedDocs/python/python/featureFlag';
15-
import {logs, verify} from 'sentry/gettingStartedDocs/python/python/logs';
16-
import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp';
17-
import {
18-
alternativeProfiling,
19-
profiling,
20-
} from 'sentry/gettingStartedDocs/python/python/profiling';
7+
import {verify} from 'sentry/gettingStartedDocs/python/python/logs';
8+
import {alternativeProfiling} from 'sentry/gettingStartedDocs/python/python/profiling';
219
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
2210
import {t, tct} from 'sentry/locale';
2311

24-
type Params = DocsParams;
25-
26-
const getSdkSetupSnippet = (params: Params) => `
12+
const getSdkSetupSnippet = (params: DocsParams) => `
2713
import sentry_sdk
2814
from sentry_sdk.integrations.quart import QuartIntegration
2915
from quart import Quart
@@ -68,7 +54,7 @@ sentry_sdk.init(
6854
)
6955
`;
7056

71-
const onboarding: OnboardingConfig = {
57+
export const onboarding: OnboardingConfig = {
7258
introduction: () =>
7359
tct('The Quart integration adds support for the [link:Quart Web Framework].', {
7460
link: <ExternalLink href="https://quart.palletsprojects.com/" />,
@@ -87,7 +73,7 @@ const onboarding: OnboardingConfig = {
8773
],
8874
},
8975
],
90-
configure: (params: Params) => [
76+
configure: (params: DocsParams) => [
9177
{
9278
type: StepType.CONFIGURE,
9379
content: [
@@ -109,7 +95,7 @@ app = Quart(__name__)
10995
],
11096
},
11197
],
112-
verify: (params: Params) => [
98+
verify: (params: DocsParams) => [
11399
{
114100
type: StepType.VERIFY,
115101
content: [
@@ -153,7 +139,7 @@ app.run()
153139
],
154140
},
155141
],
156-
nextSteps: (params: Params) => {
142+
nextSteps: (params: DocsParams) => {
157143
const steps = [] as any[];
158144
if (params.isLogsSelected) {
159145
steps.push({
@@ -168,19 +154,3 @@ app.run()
168154
return steps;
169155
},
170156
};
171-
172-
const docs: Docs = {
173-
onboarding,
174-
replayOnboardingJsLoader,
175-
profilingOnboarding: profiling({basePackage: 'sentry-sdk[quart]'}),
176-
crashReportOnboarding: crashReport,
177-
featureFlagOnboarding: featureFlag,
178-
feedbackOnboardingJsLoader,
179-
agentMonitoringOnboarding: agentMonitoring,
180-
mcpOnboarding: mcp,
181-
logsOnboarding: logs({
182-
packageName: 'sentry-sdk[quart]',
183-
}),
184-
};
185-
186-
export default docs;

0 commit comments

Comments
 (0)