Skip to content

Commit 6b62b84

Browse files
ref(onboarding): Split starlette onboarding docs (#103056)
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms
1 parent 3a5b60b commit 6b62b84

File tree

3 files changed

+38
-40
lines changed

3 files changed

+38
-40
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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({
19+
basePackage: 'sentry-sdk[starlette]',
20+
}),
21+
crashReportOnboarding: crashReport,
22+
featureFlagOnboarding: featureFlag,
23+
feedbackOnboardingJsLoader,
24+
agentMonitoringOnboarding: agentMonitoring,
25+
mcpOnboarding: mcp,
26+
logsOnboarding: logs({
27+
packageName: 'sentry-sdk[starlette]',
28+
}),
29+
};
30+
31+
export default docs;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {textWithMarkupMatcher} from 'sentry-test/utils';
66

77
import {ProductSolution} from 'sentry/components/onboarding/gettingStartedDoc/types';
88

9-
import docs from './starlette';
9+
import docs from '.';
1010

1111
describe('starlette onboarding docs', () => {
1212
it('renders doc correctly', () => {

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

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,14 @@
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} 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 {alternativeProfiling} from 'sentry/gettingStartedDocs/python/python/profiling';
218
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
229
import {t, tct} from 'sentry/locale';
2310

24-
type Params = DocsParams;
25-
26-
const getSdkSetupSnippet = (params: Params) => `
11+
const getSdkSetupSnippet = (params: DocsParams) => `
2712
from starlette.applications import Starlette
2813
import sentry_sdk
2914
@@ -66,7 +51,7 @@ sentry_sdk.init(
6651
)
6752
`;
6853

69-
const onboarding: OnboardingConfig = {
54+
export const onboarding: OnboardingConfig = {
7055
introduction: () =>
7156
tct('The Starlette integration adds support for the Starlette Framework.', {
7257
link: <ExternalLink href="https://www.starlette.io/" />,
@@ -88,7 +73,7 @@ const onboarding: OnboardingConfig = {
8873
],
8974
},
9075
],
91-
configure: (params: Params) => [
76+
configure: (params: DocsParams) => [
9277
{
9378
type: StepType.CONFIGURE,
9479
content: [
@@ -113,7 +98,7 @@ app = Starlette(routes=[...])
11398
],
11499
},
115100
],
116-
verify: (params: Params) => [
101+
verify: (params: DocsParams) => [
117102
{
118103
type: StepType.VERIFY,
119104
content: [
@@ -155,7 +140,7 @@ app = Starlette(routes=[
155140
],
156141
},
157142
],
158-
nextSteps: (params: Params) => {
143+
nextSteps: (params: DocsParams) => {
159144
const steps = [] as any[];
160145
if (params.isLogsSelected) {
161146
steps.push({
@@ -170,21 +155,3 @@ app = Starlette(routes=[
170155
return steps;
171156
},
172157
};
173-
174-
const docs: Docs = {
175-
onboarding,
176-
replayOnboardingJsLoader,
177-
profilingOnboarding: profiling({
178-
basePackage: 'sentry-sdk[starlette]',
179-
}),
180-
crashReportOnboarding: crashReport,
181-
featureFlagOnboarding: featureFlag,
182-
feedbackOnboardingJsLoader,
183-
agentMonitoringOnboarding: agentMonitoring,
184-
mcpOnboarding: mcp,
185-
logsOnboarding: logs({
186-
packageName: 'sentry-sdk[starlette]',
187-
}),
188-
};
189-
190-
export default docs;

0 commit comments

Comments
 (0)