Skip to content

Commit b755c3a

Browse files
priscilawebdevAhmed-Labs
authored andcommitted
ref(onboarding): Split connect onboarding docs (#102652)
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms
1 parent d1622d8 commit b755c3a

File tree

8 files changed

+70
-53
lines changed

8 files changed

+70
-53
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import {getNodeAgentMonitoringOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';
2+
3+
export const agentMonitoring = getNodeAgentMonitoringOnboarding();
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import {
2+
StepType,
3+
type OnboardingConfig,
4+
} from 'sentry/components/onboarding/gettingStartedDoc/types';
5+
import {
6+
getCrashReportJavaScriptInstallSteps,
7+
getCrashReportModalConfigDescription,
8+
getCrashReportModalIntroduction,
9+
} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
10+
11+
export const crashReport: OnboardingConfig = {
12+
introduction: () => getCrashReportModalIntroduction(),
13+
install: params => getCrashReportJavaScriptInstallSteps(params),
14+
configure: () => [
15+
{
16+
type: StepType.CONFIGURE,
17+
content: [
18+
{
19+
type: 'text',
20+
text: getCrashReportModalConfigDescription({
21+
link: 'https://docs.sentry.io/platforms/javascript/guides/connect/user-feedback/configuration/#crash-report-modal',
22+
}),
23+
},
24+
],
25+
},
26+
],
27+
verify: () => [],
28+
nextSteps: () => [],
29+
};
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+
3+
import {agentMonitoring} from './agentMonitoring';
4+
import {crashReport} from './crashReport';
5+
import {logs} from './logs';
6+
import {mcp} from './mcp';
7+
import {onboarding} from './onboarding';
8+
import {profiling} from './profiling';
9+
10+
const docs: Docs = {
11+
onboarding,
12+
crashReportOnboarding: crashReport,
13+
profilingOnboarding: profiling,
14+
logsOnboarding: logs,
15+
agentMonitoringOnboarding: agentMonitoring,
16+
mcpOnboarding: mcp,
17+
};
18+
19+
export default docs;
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import {getNodeLogsOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';
2+
3+
export const logs = getNodeLogsOnboarding({
4+
docsPlatform: 'connect',
5+
packageName: '@sentry/node',
6+
});
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import {getNodeMcpOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';
2+
3+
export const mcp = getNodeMcpOnboarding();

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

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

static/app/gettingStartedDocs/node/connect.tsx renamed to static/app/gettingStartedDocs/node/connect/onboarding.tsx

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,17 @@
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';
87
import {getUploadSourceMapsStep} from 'sentry/components/onboarding/gettingStartedDoc/utils';
9-
import {
10-
getCrashReportJavaScriptInstallSteps,
11-
getCrashReportModalConfigDescription,
12-
getCrashReportModalIntroduction,
13-
} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
14-
import {t, tct} from 'sentry/locale';
158
import {
169
getImportInstrumentSnippet,
1710
getInstallCodeBlock,
18-
getNodeAgentMonitoringOnboarding,
19-
getNodeLogsOnboarding,
20-
getNodeMcpOnboarding,
21-
getNodeProfilingOnboarding,
2211
getSdkInitSnippet,
2312
getSentryImportSnippet,
24-
} from 'sentry/utils/gettingStartedDocs/node';
25-
26-
type Params = DocsParams;
13+
} from 'sentry/gettingStartedDocs/node/node/utils';
14+
import {t, tct} from 'sentry/locale';
2715

2816
const getSdkSetupSnippet = () => `
2917
${getImportInstrumentSnippet()}
@@ -41,7 +29,7 @@ Sentry.setupConnectErrorHandler(app);
4129
app.listen(3000);
4230
`;
4331

44-
const onboarding: OnboardingConfig = {
32+
export const onboarding: OnboardingConfig = {
4533
introduction: () =>
4634
tct("In this quick guide you'll use [strong:npm] or [strong:yarn] to set up:", {
4735
strong: <strong />,
@@ -116,7 +104,7 @@ const onboarding: OnboardingConfig = {
116104
...params,
117105
}),
118106
],
119-
verify: (params: Params) => [
107+
verify: (params: DocsParams) => [
120108
{
121109
type: StepType.VERIFY,
122110
content: [
@@ -134,7 +122,7 @@ const onboarding: OnboardingConfig = {
134122
],
135123
},
136124
],
137-
nextSteps: (params: Params) => {
125+
nextSteps: (params: DocsParams) => {
138126
const steps = [];
139127

140128
if (params.isLogsSelected) {
@@ -152,7 +140,7 @@ const onboarding: OnboardingConfig = {
152140
},
153141
};
154142

155-
const getVerifySnippet = (params: Params) => `
143+
const getVerifySnippet = (params: DocsParams) => `
156144
app.use(async function () {${
157145
params.isLogsSelected
158146
? `
@@ -165,37 +153,3 @@ app.use(async function () {${
165153
throw new Error("My first Sentry error!");
166154
});
167155
`;
168-
169-
const crashReportOnboarding: OnboardingConfig = {
170-
introduction: () => getCrashReportModalIntroduction(),
171-
install: (params: Params) => getCrashReportJavaScriptInstallSteps(params),
172-
configure: () => [
173-
{
174-
type: StepType.CONFIGURE,
175-
content: [
176-
{
177-
type: 'text',
178-
text: getCrashReportModalConfigDescription({
179-
link: 'https://docs.sentry.io/platforms/javascript/guides/connect/user-feedback/configuration/#crash-report-modal',
180-
}),
181-
},
182-
],
183-
},
184-
],
185-
verify: () => [],
186-
nextSteps: () => [],
187-
};
188-
189-
const docs: Docs = {
190-
onboarding,
191-
crashReportOnboarding,
192-
profilingOnboarding: getNodeProfilingOnboarding(),
193-
logsOnboarding: getNodeLogsOnboarding({
194-
docsPlatform: 'connect',
195-
packageName: '@sentry/node',
196-
}),
197-
agentMonitoringOnboarding: getNodeAgentMonitoringOnboarding(),
198-
mcpOnboarding: getNodeMcpOnboarding(),
199-
};
200-
201-
export default docs;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import {getNodeProfilingOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';
2+
3+
export const profiling = getNodeProfilingOnboarding();

0 commit comments

Comments
 (0)