Skip to content

Commit 63cdb14

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

File tree

3 files changed

+36
-35
lines changed

3 files changed

+36
-35
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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 {profiling} from 'sentry/gettingStartedDocs/python/python/profiling';
11+
12+
import {onboarding} from './onboarding';
13+
14+
const docs: Docs = {
15+
onboarding,
16+
replayOnboardingJsLoader,
17+
crashReportOnboarding: crashReport,
18+
featureFlagOnboarding: featureFlag,
19+
feedbackOnboardingJsLoader,
20+
profilingOnboarding: profiling(),
21+
agentMonitoringOnboarding: agentMonitoring,
22+
logsOnboarding: logs(),
23+
};
24+
25+
export default docs;

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

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

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

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,14 @@
11
import {ExternalLink} from 'sentry/components/core/link';
2-
import type {
3-
Docs,
4-
DocsParams,
5-
OnboardingConfig,
6-
} from 'sentry/components/onboarding/gettingStartedDoc/types';
7-
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/types';
82
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 {profiling} from 'sentry/gettingStartedDocs/python/python/profiling';
3+
StepType,
4+
type DocsParams,
5+
type OnboardingConfig,
6+
} from 'sentry/components/onboarding/gettingStartedDoc/types';
7+
import {verify} from 'sentry/gettingStartedDocs/python/python/logs';
178
import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
189
import {t, tct} from 'sentry/locale';
1910

20-
type Params = DocsParams;
21-
22-
const getSdkSetupSnippet = (params: Params) => `
11+
const getSdkSetupSnippet = (params: DocsParams) => `
2312
from pyramid.config import Configurator
2413
import sentry_sdk
2514
@@ -37,7 +26,7 @@ sentry_sdk.init(
3726
)
3827
`;
3928

40-
const onboarding: OnboardingConfig = {
29+
export const onboarding: OnboardingConfig = {
4130
introduction: () =>
4231
tct('The Pyramid integration adds support for the [link:Pyramid Web Framework].', {
4332
link: <ExternalLink href="https://trypyramid.com/" />,
@@ -56,7 +45,7 @@ const onboarding: OnboardingConfig = {
5645
],
5746
},
5847
],
59-
configure: (params: Params) => [
48+
configure: (params: DocsParams) => [
6049
{
6150
type: StepType.CONFIGURE,
6251
content: [
@@ -81,7 +70,7 @@ with Configurator() as config:
8170
],
8271
},
8372
],
84-
verify: (params: Params) => [
73+
verify: (params: DocsParams) => [
8574
{
8675
type: StepType.VERIFY,
8776
content: [
@@ -123,7 +112,7 @@ if __name__ == '__main__':
123112
],
124113
},
125114
],
126-
nextSteps: (params: Params) => {
115+
nextSteps: (params: DocsParams) => {
127116
const steps = [];
128117
if (params.isLogsSelected) {
129118
steps.push({
@@ -138,16 +127,3 @@ if __name__ == '__main__':
138127
return steps;
139128
},
140129
};
141-
142-
const docs: Docs = {
143-
onboarding,
144-
replayOnboardingJsLoader,
145-
crashReportOnboarding: crashReport,
146-
featureFlagOnboarding: featureFlag,
147-
feedbackOnboardingJsLoader,
148-
profilingOnboarding: profiling(),
149-
agentMonitoringOnboarding: agentMonitoring,
150-
logsOnboarding: logs(),
151-
};
152-
153-
export default docs;

0 commit comments

Comments
 (0)