Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import {getNodeAgentMonitoringOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';

export const agentMonitoring = getNodeAgentMonitoringOnboarding();
29 changes: 29 additions & 0 deletions static/app/gettingStartedDocs/node/fastify/crashReport.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import {
StepType,
type OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {
getCrashReportJavaScriptInstallSteps,
getCrashReportModalConfigDescription,
getCrashReportModalIntroduction,
} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';

export const crashReport: OnboardingConfig = {
introduction: () => getCrashReportModalIntroduction(),
install: params => getCrashReportJavaScriptInstallSteps(params),
configure: () => [
{
type: StepType.CONFIGURE,
content: [
{
type: 'text',
text: getCrashReportModalConfigDescription({
link: 'https://docs.sentry.io/platforms/javascript/guides/express/user-feedback/configuration/#crash-report-modal',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Broken link in crash report docs for Fastify

The crash report configuration documentation link incorrectly points to the Express platform documentation (/express/user-feedback/configuration/#crash-report-modal) instead of the Fastify platform documentation. It should be https://docs.sentry.io/platforms/javascript/guides/fastify/user-feedback/configuration/#crash-report-modal to match the platform being documented.

Fix in Cursor Fix in Web

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you are right, but this is the same we have in master and there is no user-feedback crash report modal link for fastify

}),
},
],
},
],
verify: () => [],
nextSteps: () => [],
};
25 changes: 25 additions & 0 deletions static/app/gettingStartedDocs/node/fastify/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {
feedbackOnboardingJsLoader,
replayOnboardingJsLoader,
} from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';

import {agentMonitoring} from './agentMonitoring';
import {crashReport} from './crashReport';
import {logs} from './logs';
import {mcp} from './mcp';
import {onboarding} from './onboarding';
import {profiling} from './profiling';

const docs: Docs = {
onboarding,
replayOnboardingJsLoader,
crashReportOnboarding: crashReport,
feedbackOnboardingJsLoader,
profilingOnboarding: profiling,
logsOnboarding: logs,
agentMonitoringOnboarding: agentMonitoring,
mcpOnboarding: mcp,
};

export default docs;
6 changes: 6 additions & 0 deletions static/app/gettingStartedDocs/node/fastify/logs.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import {getNodeLogsOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';

export const logs = getNodeLogsOnboarding({
docsPlatform: 'fastify',
packageName: '@sentry/node',
});
3 changes: 3 additions & 0 deletions static/app/gettingStartedDocs/node/fastify/mcp.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import {getNodeMcpOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';

export const mcp = getNodeMcpOnboarding();
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {textWithMarkupMatcher} from 'sentry-test/utils';

import {ProductSolution} from 'sentry/components/onboarding/gettingStartedDoc/types';

import docs from './fastify';
import docs from '.';

describe('fastify onboarding docs', () => {
it('renders onboarding docs correctly', () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,33 +1,17 @@
import {ExternalLink} from 'sentry/components/core/link';
import type {
Docs,
DocsParams,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {getUploadSourceMapsStep} from 'sentry/components/onboarding/gettingStartedDoc/utils';
import {
getCrashReportJavaScriptInstallSteps,
getCrashReportModalConfigDescription,
getCrashReportModalIntroduction,
} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
import {
feedbackOnboardingJsLoader,
replayOnboardingJsLoader,
} from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
import {t, tct} from 'sentry/locale';
import {
getImportInstrumentSnippet,
getInstallCodeBlock,
getNodeAgentMonitoringOnboarding,
getNodeLogsOnboarding,
getNodeMcpOnboarding,
getNodeProfilingOnboarding,
getSdkInitSnippet,
getSentryImportSnippet,
} from 'sentry/utils/gettingStartedDocs/node';

type Params = DocsParams;
} from 'sentry/gettingStartedDocs/node/node/utils';
import {t, tct} from 'sentry/locale';

const getSdkSetupSnippet = () => `
${getImportInstrumentSnippet()}
Expand All @@ -47,12 +31,12 @@ app.get("/", function rootHandler(req, res) {
app.listen(3000);
`;

const onboarding: OnboardingConfig = {
export const onboarding: OnboardingConfig = {
introduction: () =>
tct("In this quick guide you'll use [strong:npm] or [strong:yarn] to set up:", {
strong: <strong />,
}),
install: (params: Params) => [
install: (params: DocsParams) => [
{
type: StepType.INSTALL,
content: [
Expand All @@ -64,7 +48,7 @@ const onboarding: OnboardingConfig = {
],
},
],
configure: (params: Params) => [
configure: (params: DocsParams) => [
{
type: StepType.CONFIGURE,
content: [
Expand Down Expand Up @@ -122,7 +106,7 @@ const onboarding: OnboardingConfig = {
...params,
}),
],
verify: (params: Params) => [
verify: (params: DocsParams) => [
{
type: StepType.VERIFY,
content: [
Expand Down Expand Up @@ -152,7 +136,7 @@ app.get("/debug-sentry", function mainHandler(req, res) {${
],
},
],
nextSteps: (params: Params) => {
nextSteps: (params: DocsParams) => {
const steps = [];

if (params.isLogsSelected) {
Expand All @@ -169,39 +153,3 @@ app.get("/debug-sentry", function mainHandler(req, res) {${
return steps;
},
};

const crashReportOnboarding: OnboardingConfig = {
introduction: () => getCrashReportModalIntroduction(),
install: (params: Params) => getCrashReportJavaScriptInstallSteps(params),
configure: () => [
{
type: StepType.CONFIGURE,
content: [
{
type: 'text',
text: getCrashReportModalConfigDescription({
link: 'https://docs.sentry.io/platforms/javascript/guides/express/user-feedback/configuration/#crash-report-modal',
}),
},
],
},
],
verify: () => [],
nextSteps: () => [],
};

const docs: Docs = {
onboarding,
replayOnboardingJsLoader,
crashReportOnboarding,
feedbackOnboardingJsLoader,
profilingOnboarding: getNodeProfilingOnboarding(),
logsOnboarding: getNodeLogsOnboarding({
docsPlatform: 'fastify',
packageName: '@sentry/node',
}),
agentMonitoringOnboarding: getNodeAgentMonitoringOnboarding(),
mcpOnboarding: getNodeMcpOnboarding(),
};

export default docs;
3 changes: 3 additions & 0 deletions static/app/gettingStartedDocs/node/fastify/profiling.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import {getNodeProfilingOnboarding} from 'sentry/gettingStartedDocs/node/node/utils';

export const profiling = getNodeProfilingOnboarding();
Loading