Skip to content

Commit 664092f

Browse files
ref(onboarding): Split tryton onboarding docs (#103057)
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms
1 parent 4b55fea commit 664092f

File tree

4 files changed

+48
-40
lines changed

4 files changed

+48
-40
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types';
2+
import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
3+
import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
4+
import {logs} from 'sentry/gettingStartedDocs/python/python/logs';
5+
import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp';
6+
7+
import {onboarding} from './onboarding';
8+
import {profiling} from './profiling';
9+
10+
const docs: Docs = {
11+
onboarding,
12+
profilingOnboarding: profiling,
13+
crashReportOnboarding: crashReport,
14+
agentMonitoringOnboarding: agentMonitoring,
15+
mcpOnboarding: mcp,
16+
logsOnboarding: logs(),
17+
};
18+
19+
export default docs;

static/app/gettingStartedDocs/python/tryton.spec.tsx renamed to static/app/gettingStartedDocs/python/tryton/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 './tryton';
9+
import docs from '.';
1010

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

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

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
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 {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
9-
import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
10-
import {logs} from 'sentry/gettingStartedDocs/python/python/logs';
11-
import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp';
127
import {alternativeProfiling} from 'sentry/gettingStartedDocs/python/python/profiling';
138
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
149
import {t, tct} from 'sentry/locale';
1510

16-
type Params = DocsParams;
17-
18-
const getSdkSetupSnippet = (params: Params) => `
11+
const getSdkSetupSnippet = (params: DocsParams) => `
1912
import sentry_sdk
2013
from sentry_sdk.integrations.trytond import TrytondWSGIIntegration
2114
@@ -77,7 +70,7 @@ def _(app, request, e):
7770
data = UserError('Custom message', f'{event_id}{e}')
7871
return app.make_response(request, data)`;
7972

80-
const onboarding: OnboardingConfig = {
73+
export const onboarding: OnboardingConfig = {
8174
introduction: () =>
8275
tct('The Tryton integration adds support for the [link:Tryton Framework Server].', {
8376
link: <ExternalLink href="https://www.tryton.org/" />,
@@ -96,7 +89,7 @@ const onboarding: OnboardingConfig = {
9689
],
9790
},
9891
],
99-
configure: (params: Params) => [
92+
configure: (params: DocsParams) => [
10093
{
10194
type: StepType.CONFIGURE,
10295
content: [
@@ -141,32 +134,3 @@ const onboarding: OnboardingConfig = {
141134
],
142135
verify: () => [],
143136
};
144-
145-
const profilingOnboarding: OnboardingConfig = {
146-
install: onboarding.install,
147-
configure: onboarding.configure,
148-
verify: () => [
149-
{
150-
type: StepType.VERIFY,
151-
content: [
152-
{
153-
type: 'text',
154-
text: t(
155-
'Verify that profiling is working correctly by simply using your application.'
156-
),
157-
},
158-
],
159-
},
160-
],
161-
};
162-
163-
const docs: Docs = {
164-
onboarding,
165-
profilingOnboarding,
166-
crashReportOnboarding: crashReport,
167-
agentMonitoringOnboarding: agentMonitoring,
168-
mcpOnboarding: mcp,
169-
logsOnboarding: logs(),
170-
};
171-
172-
export default docs;
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import {
2+
StepType,
3+
type OnboardingConfig,
4+
} from 'sentry/components/onboarding/gettingStartedDoc/types';
5+
import {t} from 'sentry/locale';
6+
7+
import {onboarding} from './onboarding';
8+
9+
export const profiling: OnboardingConfig = {
10+
install: onboarding.install,
11+
configure: onboarding.configure,
12+
verify: () => [
13+
{
14+
type: StepType.VERIFY,
15+
content: [
16+
{
17+
type: 'text',
18+
text: t(
19+
'Verify that profiling is working correctly by simply using your application.'
20+
),
21+
},
22+
],
23+
},
24+
],
25+
};

0 commit comments

Comments
 (0)