Skip to content

Commit 1cb85d0

Browse files
priscilawebdevandrewshie-sentry
priscilawebdev
authored and
andrewshie-sentry
committed
ref(onboarding): Split python onboarding docs (#103029)
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms
1 parent e99742f commit 1cb85d0

35 files changed

+1508
-1562
lines changed

‎static/app/gettingStartedDocs/python/aiohttp.tsx‎

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,20 @@ import {
99
feedbackOnboardingJsLoader,
1010
replayOnboardingJsLoader,
1111
} 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';
1217
import {
13-
agentMonitoringOnboarding,
14-
crashReportOnboardingPython,
15-
featureFlagOnboarding,
16-
mcpOnboarding,
17-
} from 'sentry/gettingStartedDocs/python/python';
18-
import {t, tct} from 'sentry/locale';
18+
alternativeProfiling,
19+
profiling,
20+
} from 'sentry/gettingStartedDocs/python/python/profiling';
1921
import {
20-
alternativeProfilingConfiguration,
2122
getPythonAiocontextvarsCodeBlocks,
2223
getPythonInstallCodeBlock,
23-
getPythonLogsOnboarding,
24-
getPythonProfilingOnboarding,
25-
getVerifyLogsContent,
26-
} from 'sentry/utils/gettingStartedDocs/python';
24+
} from 'sentry/gettingStartedDocs/python/python/utils';
25+
import {t, tct} from 'sentry/locale';
2726

2827
type Params = DocsParams;
2928

@@ -112,7 +111,7 @@ const onboarding: OnboardingConfig = {
112111
language: 'python',
113112
code: getSdkSetupSnippet(params),
114113
},
115-
alternativeProfilingConfiguration(params),
114+
alternativeProfiling(params),
116115
],
117116
},
118117
],
@@ -140,7 +139,7 @@ app.add_routes([web.get('/', hello)])
140139
web.run_app(app)
141140
`,
142141
},
143-
getVerifyLogsContent(params),
142+
verify(params),
144143
{
145144
type: 'text',
146145
text: [
@@ -175,18 +174,16 @@ web.run_app(app)
175174
},
176175
};
177176

178-
const logsOnboarding = getPythonLogsOnboarding();
179-
180177
const docs: Docs = {
181178
onboarding,
182179
replayOnboardingJsLoader,
183-
profilingOnboarding: getPythonProfilingOnboarding(),
184-
crashReportOnboarding: crashReportOnboardingPython,
185-
featureFlagOnboarding,
180+
profilingOnboarding: profiling(),
181+
crashReportOnboarding: crashReport,
182+
featureFlagOnboarding: featureFlag,
186183
feedbackOnboardingJsLoader,
187-
agentMonitoringOnboarding,
188-
mcpOnboarding,
189-
logsOnboarding,
184+
agentMonitoringOnboarding: agentMonitoring,
185+
mcpOnboarding: mcp,
186+
logsOnboarding: logs(),
190187
};
191188

192189
export default docs;

‎static/app/gettingStartedDocs/python/asgi.tsx‎

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,16 @@ import {
55
type DocsParams,
66
type OnboardingConfig,
77
} from 'sentry/components/onboarding/gettingStartedDoc/types';
8+
import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
9+
import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
10+
import {logs, verify} from 'sentry/gettingStartedDocs/python/python/logs';
11+
import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp';
812
import {
9-
agentMonitoringOnboarding,
10-
crashReportOnboardingPython,
11-
mcpOnboarding,
12-
} from 'sentry/gettingStartedDocs/python/python';
13+
alternativeProfiling,
14+
profiling,
15+
} from 'sentry/gettingStartedDocs/python/python/profiling';
16+
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
1317
import {t, tct} from 'sentry/locale';
14-
import {
15-
alternativeProfilingConfiguration,
16-
getPythonInstallCodeBlock,
17-
getPythonLogsOnboarding,
18-
getPythonProfilingOnboarding,
19-
getVerifyLogsContent,
20-
} from 'sentry/utils/gettingStartedDocs/python';
2118

2219
type Params = DocsParams;
2320

@@ -130,7 +127,7 @@ const onboarding: OnboardingConfig = {
130127
language: 'python',
131128
code: getSdkSetupSnippet(params),
132129
},
133-
alternativeProfilingConfiguration(params),
130+
alternativeProfiling(params),
134131
{
135132
type: 'text',
136133
text: t('The middleware supports both ASGI 2 and ASGI 3 transparently.'),
@@ -151,7 +148,7 @@ const onboarding: OnboardingConfig = {
151148
language: 'python',
152149
code: getVerifySnippet(),
153150
},
154-
getVerifyLogsContent(params),
151+
verify(params),
155152
{
156153
type: 'text',
157154
text: tct(
@@ -187,15 +184,13 @@ const onboarding: OnboardingConfig = {
187184
},
188185
};
189186

190-
const logsOnboarding = getPythonLogsOnboarding();
191-
192187
const docs: Docs = {
193188
onboarding,
194-
crashReportOnboarding: crashReportOnboardingPython,
195-
profilingOnboarding: getPythonProfilingOnboarding(),
196-
agentMonitoringOnboarding,
197-
mcpOnboarding,
198-
logsOnboarding,
189+
crashReportOnboarding: crashReport,
190+
profilingOnboarding: profiling(),
191+
agentMonitoringOnboarding: agentMonitoring,
192+
mcpOnboarding: mcp,
193+
logsOnboarding: logs(),
199194
};
200195

201196
export default docs;

‎static/app/gettingStartedDocs/python/awslambda.tsx‎

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,12 @@ import {
66
type OnboardingConfig,
77
type OnboardingStep,
88
} from 'sentry/components/onboarding/gettingStartedDoc/types';
9-
import {
10-
agentMonitoringOnboarding,
11-
crashReportOnboardingPython,
12-
} from 'sentry/gettingStartedDocs/python/python';
9+
import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
10+
import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
11+
import {logs, verify} from 'sentry/gettingStartedDocs/python/python/logs';
12+
import {alternativeProfiling} from 'sentry/gettingStartedDocs/python/python/profiling';
13+
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
1314
import {t, tct} from 'sentry/locale';
14-
import {
15-
alternativeProfilingConfiguration,
16-
getPythonInstallCodeBlock,
17-
getPythonLogsOnboarding,
18-
getVerifyLogsContent,
19-
} from 'sentry/utils/gettingStartedDocs/python';
2015

2116
type Params = DocsParams;
2217

@@ -99,7 +94,7 @@ const configureStep = (params: Params): OnboardingStep => ({
9994
language: 'python',
10095
code: getSdkSetupSnippet(params),
10196
},
102-
alternativeProfilingConfiguration(params),
97+
alternativeProfiling(params),
10398
{
10499
type: 'text',
105100
text: tct("Check out Sentry's [link:AWS sample apps] for detailed examples.", {
@@ -181,7 +176,7 @@ const onboarding: OnboardingConfig = {
181176
'Deploy your function and invoke it to generate an error, then check Sentry for the captured event.'
182177
),
183178
},
184-
getVerifyLogsContent(params),
179+
verify(params),
185180
],
186181
},
187182
],
@@ -219,14 +214,12 @@ const profilingOnboarding: OnboardingConfig = {
219214
],
220215
};
221216

222-
const logsOnboarding = getPythonLogsOnboarding();
223-
224217
const docs: Docs = {
225218
onboarding,
226-
crashReportOnboarding: crashReportOnboardingPython,
219+
crashReportOnboarding: crashReport,
227220
profilingOnboarding,
228-
agentMonitoringOnboarding,
229-
logsOnboarding,
221+
agentMonitoringOnboarding: agentMonitoring,
222+
logsOnboarding: logs(),
230223
};
231224

232225
export default docs;

‎static/app/gettingStartedDocs/python/bottle.tsx‎

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,17 @@ import {
99
feedbackOnboardingJsLoader,
1010
replayOnboardingJsLoader,
1111
} 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';
1217
import {
13-
agentMonitoringOnboarding,
14-
crashReportOnboardingPython,
15-
featureFlagOnboarding,
16-
mcpOnboarding,
17-
} from 'sentry/gettingStartedDocs/python/python';
18+
alternativeProfiling,
19+
profiling,
20+
} from 'sentry/gettingStartedDocs/python/python/profiling';
21+
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
1822
import {t, tct} from 'sentry/locale';
19-
import {
20-
alternativeProfilingConfiguration,
21-
getPythonInstallCodeBlock,
22-
getPythonLogsOnboarding,
23-
getPythonProfilingOnboarding,
24-
getVerifyLogsContent,
25-
} from 'sentry/utils/gettingStartedDocs/python';
2623

2724
type Params = DocsParams;
2825

@@ -108,7 +105,7 @@ ${getSdkSetupSnippet(params)}
108105
app = Bottle()
109106
`,
110107
},
111-
alternativeProfilingConfiguration(params),
108+
alternativeProfiling(params),
112109
],
113110
},
114111
],
@@ -135,7 +132,7 @@ def hello():
135132
run(app, host='localhost', port=8000)
136133
`,
137134
},
138-
getVerifyLogsContent(params),
135+
verify(params),
139136
{
140137
type: 'text',
141138
text: [
@@ -170,20 +167,18 @@ run(app, host='localhost', port=8000)
170167
},
171168
};
172169

173-
const logsOnboarding = getPythonLogsOnboarding({
174-
packageName: 'sentry-sdk[bottle]',
175-
});
176-
177170
const docs: Docs = {
178171
onboarding,
179172
replayOnboardingJsLoader,
180-
profilingOnboarding: getPythonProfilingOnboarding({basePackage: 'sentry-sdk[bottle]'}),
181-
crashReportOnboarding: crashReportOnboardingPython,
182-
featureFlagOnboarding,
173+
profilingOnboarding: profiling({basePackage: 'sentry-sdk[bottle]'}),
174+
crashReportOnboarding: crashReport,
175+
featureFlagOnboarding: featureFlag,
183176
feedbackOnboardingJsLoader,
184-
agentMonitoringOnboarding,
185-
mcpOnboarding,
186-
logsOnboarding,
177+
agentMonitoringOnboarding: agentMonitoring,
178+
mcpOnboarding: mcp,
179+
logsOnboarding: logs({
180+
packageName: 'sentry-sdk[bottle]',
181+
}),
187182
};
188183

189184
export default docs;

‎static/app/gettingStartedDocs/python/celery.tsx‎

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,15 @@ import {
55
type DocsParams,
66
type OnboardingConfig,
77
} from 'sentry/components/onboarding/gettingStartedDoc/types';
8+
import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
9+
import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
10+
import {logs, verify} from 'sentry/gettingStartedDocs/python/python/logs';
811
import {
9-
agentMonitoringOnboarding,
10-
crashReportOnboardingPython,
11-
} from 'sentry/gettingStartedDocs/python/python';
12+
alternativeProfiling,
13+
profiling,
14+
} from 'sentry/gettingStartedDocs/python/python/profiling';
15+
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
1216
import {t, tct} from 'sentry/locale';
13-
import {
14-
alternativeProfilingConfiguration,
15-
getPythonInstallCodeBlock,
16-
getPythonLogsOnboarding,
17-
getPythonProfilingOnboarding,
18-
getVerifyLogsContent,
19-
} from 'sentry/utils/gettingStartedDocs/python';
2017

2118
type Params = DocsParams;
2219

@@ -107,7 +104,7 @@ const onboarding: OnboardingConfig = {
107104
language: 'python',
108105
code: getSdkSetupSnippet(params),
109106
},
110-
alternativeProfilingConfiguration(params),
107+
alternativeProfiling(params),
111108
{
112109
type: 'subheader',
113110
text: t('Standalone Setup'),
@@ -200,22 +197,20 @@ def hello():
200197
hello.delay()
201198
`,
202199
},
203-
getVerifyLogsContent(params),
200+
verify(params),
204201
],
205202
},
206203
],
207204
};
208205

209-
const logsOnboarding = getPythonLogsOnboarding({
210-
packageName: 'sentry-sdk[celery]',
211-
});
212-
213206
const docs: Docs = {
214207
onboarding,
215-
profilingOnboarding: getPythonProfilingOnboarding({basePackage: 'sentry-sdk[celery]'}),
216-
crashReportOnboarding: crashReportOnboardingPython,
217-
agentMonitoringOnboarding,
218-
logsOnboarding,
208+
profilingOnboarding: profiling({basePackage: 'sentry-sdk[celery]'}),
209+
crashReportOnboarding: crashReport,
210+
agentMonitoringOnboarding: agentMonitoring,
211+
logsOnboarding: logs({
212+
packageName: 'sentry-sdk[celery]',
213+
}),
219214
};
220215

221216
export default docs;

0 commit comments

Comments
 (0)