Skip to content

Commit 51244d9

Browse files
ref(onboarding): Split sanic onboarding docs (#103054)
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms
1 parent 63cdb14 commit 51244d9

File tree

3 files changed

+35
-35
lines changed

3 files changed

+35
-35
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+
crashReportOnboarding: crashReport,
19+
featureFlagOnboarding: featureFlag,
20+
feedbackOnboardingJsLoader,
21+
profilingOnboarding: profiling({basePackage: 'sentry-sdk[sanic]'}),
22+
agentMonitoringOnboarding: agentMonitoring,
23+
mcpOnboarding: mcp,
24+
logsOnboarding: logs({
25+
packageName: 'sentry-sdk[sanic]',
26+
}),
27+
};
28+
29+
export default docs;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import {renderWithOnboardingLayout} from 'sentry-test/onboarding/renderWithOnboardingLayout';
22
import {screen} from 'sentry-test/reactTestingLibrary';
33

4-
import docs from './sanic';
4+
import docs from '.';
55

66
describe('sanic onboarding docs', () => {
77
it('renders doc correctly', () => {

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

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,16 @@
11
import {ExternalLink} from 'sentry/components/core/link';
22
import type {
3-
Docs,
43
DocsParams,
54
OnboardingConfig,
65
} from 'sentry/components/onboarding/gettingStartedDoc/types';
76
import {StepType} 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 {profiling} from 'sentry/gettingStartedDocs/python/python/profiling';
187
import {
198
getPythonAiocontextvarsCodeBlocks,
209
getPythonInstallCodeBlock,
2110
} from 'sentry/gettingStartedDocs/python/python/utils';
2211
import {t, tct} from 'sentry/locale';
2312

24-
type Params = DocsParams;
25-
26-
const getSdkSetupSnippet = (params: Params) => `from sanic import Sanic
13+
const getSdkSetupSnippet = (params: DocsParams) => `from sanic import Sanic
2714
import sentry_sdk
2815
2916
sentry_sdk.init(
@@ -40,7 +27,7 @@ sentry_sdk.init(
4027
)
4128
`;
4229

43-
const onboarding: OnboardingConfig = {
30+
export const onboarding: OnboardingConfig = {
4431
introduction: () =>
4532
tct('The Sanic integration adds support for the [link:Sanic Web Framework].', {
4633
link: <ExternalLink href="https://github.com/sanic-org/sanic" />,
@@ -60,7 +47,7 @@ const onboarding: OnboardingConfig = {
6047
],
6148
},
6249
],
63-
configure: (params: Params) => [
50+
configure: (params: DocsParams) => [
6451
{
6552
type: StepType.CONFIGURE,
6653
content: [
@@ -83,7 +70,7 @@ app = Sanic(__name__)
8370
],
8471
},
8572
],
86-
verify: (params: Params) => [
73+
verify: (params: DocsParams) => [
8774
{
8875
type: StepType.VERIFY,
8976
content: [
@@ -118,7 +105,7 @@ async def hello_world(request):
118105
],
119106
},
120107
],
121-
nextSteps: (params: Params) => {
108+
nextSteps: (params: DocsParams) => {
122109
const steps = [] as any[];
123110
if (params.isLogsSelected) {
124111
steps.push({
@@ -133,19 +120,3 @@ async def hello_world(request):
133120
return steps;
134121
},
135122
};
136-
137-
const docs: Docs = {
138-
onboarding,
139-
replayOnboardingJsLoader,
140-
crashReportOnboarding: crashReport,
141-
featureFlagOnboarding: featureFlag,
142-
feedbackOnboardingJsLoader,
143-
profilingOnboarding: profiling({basePackage: 'sentry-sdk[sanic]'}),
144-
agentMonitoringOnboarding: agentMonitoring,
145-
mcpOnboarding: mcp,
146-
logsOnboarding: logs({
147-
packageName: 'sentry-sdk[sanic]',
148-
}),
149-
};
150-
151-
export default docs;

0 commit comments

Comments
 (0)