From 2d29ff3ad5468396d3b31f6b3f94654e94ac3f79 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Fri, 7 Nov 2025 08:25:41 +0100 Subject: [PATCH] ref(onboarding): Split Maui onboarding docs --- .../dotnet/maui/crashReport.tsx | 27 +++++++++++ .../gettingStartedDocs/dotnet/maui/index.tsx | 13 ++++++ .../onboarding.spec.tsx} | 2 +- .../dotnet/{maui.tsx => maui/onboarding.tsx} | 45 ++----------------- 4 files changed, 45 insertions(+), 42 deletions(-) create mode 100644 static/app/gettingStartedDocs/dotnet/maui/crashReport.tsx create mode 100644 static/app/gettingStartedDocs/dotnet/maui/index.tsx rename static/app/gettingStartedDocs/dotnet/{maui.spec.tsx => maui/onboarding.spec.tsx} (98%) rename static/app/gettingStartedDocs/dotnet/{maui.tsx => maui/onboarding.tsx} (84%) diff --git a/static/app/gettingStartedDocs/dotnet/maui/crashReport.tsx b/static/app/gettingStartedDocs/dotnet/maui/crashReport.tsx new file mode 100644 index 00000000000000..0b2e8206da5411 --- /dev/null +++ b/static/app/gettingStartedDocs/dotnet/maui/crashReport.tsx @@ -0,0 +1,27 @@ +import type {OnboardingConfig} from 'sentry/components/onboarding/gettingStartedDoc/types'; +import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/types'; +import { + getCrashReportGenericInstallSteps, + getCrashReportModalConfigDescription, + getCrashReportModalIntroduction, +} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding'; + +export const crashReport: OnboardingConfig = { + introduction: () => getCrashReportModalIntroduction(), + install: params => getCrashReportGenericInstallSteps(params), + configure: () => [ + { + type: StepType.CONFIGURE, + content: [ + { + type: 'text', + text: getCrashReportModalConfigDescription({ + link: 'https://docs.sentry.io/platforms/dotnet/guides/maui/user-feedback/configuration/#crash-report-modal', + }), + }, + ], + }, + ], + verify: () => [], + nextSteps: () => [], +}; diff --git a/static/app/gettingStartedDocs/dotnet/maui/index.tsx b/static/app/gettingStartedDocs/dotnet/maui/index.tsx new file mode 100644 index 00000000000000..c20a1b29cbc26b --- /dev/null +++ b/static/app/gettingStartedDocs/dotnet/maui/index.tsx @@ -0,0 +1,13 @@ +import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types'; +import {feedback} from 'sentry/gettingStartedDocs/dotnet/dotnet/feedback'; + +import {crashReport} from './crashReport'; +import {onboarding} from './onboarding'; + +const docs: Docs = { + onboarding, + feedbackOnboardingCrashApi: feedback, + crashReportOnboarding: crashReport, +}; + +export default docs; diff --git a/static/app/gettingStartedDocs/dotnet/maui.spec.tsx b/static/app/gettingStartedDocs/dotnet/maui/onboarding.spec.tsx similarity index 98% rename from static/app/gettingStartedDocs/dotnet/maui.spec.tsx rename to static/app/gettingStartedDocs/dotnet/maui/onboarding.spec.tsx index df7920dbf4eca6..b2e5bb106c95e1 100644 --- a/static/app/gettingStartedDocs/dotnet/maui.spec.tsx +++ b/static/app/gettingStartedDocs/dotnet/maui/onboarding.spec.tsx @@ -4,7 +4,7 @@ import {textWithMarkupMatcher} from 'sentry-test/utils'; import {ProductSolution} from 'sentry/components/onboarding/gettingStartedDoc/types'; -import docs from './maui'; +import docs from './index'; describe('maui onboarding docs', () => { it('renders errors onboarding docs correctly', async () => { diff --git a/static/app/gettingStartedDocs/dotnet/maui.tsx b/static/app/gettingStartedDocs/dotnet/maui/onboarding.tsx similarity index 84% rename from static/app/gettingStartedDocs/dotnet/maui.tsx rename to static/app/gettingStartedDocs/dotnet/maui/onboarding.tsx index 02db3244a4670e..027ac54907d6b7 100644 --- a/static/app/gettingStartedDocs/dotnet/maui.tsx +++ b/static/app/gettingStartedDocs/dotnet/maui/onboarding.tsx @@ -1,37 +1,28 @@ import {ExternalLink} from 'sentry/components/core/link'; import type { - Docs, DocsParams, OnboardingConfig, OnboardingStep, } from 'sentry/components/onboarding/gettingStartedDoc/types'; import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/types'; -import { - getCrashReportGenericInstallSteps, - getCrashReportModalConfigDescription, - getCrashReportModalIntroduction, -} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding'; -import {csharpFeedbackOnboarding} from 'sentry/gettingStartedDocs/dotnet/dotnet'; import {t, tct} from 'sentry/locale'; import {getPackageVersion} from 'sentry/utils/gettingStartedDocs/getPackageVersion'; -type Params = DocsParams; - -const getInstallSnippetPackageManager = (params: Params) => ` +const getInstallSnippetPackageManager = (params: DocsParams) => ` Install-Package Sentry.Maui -Version ${getPackageVersion( params, 'sentry.dotnet.maui', '4.3.0' )}`; -const getInstallSnippetCoreCli = (params: Params) => ` +const getInstallSnippetCoreCli = (params: DocsParams) => ` dotnet add package Sentry.Maui -v ${getPackageVersion( params, 'sentry.dotnet.maui', '4.3.0' )}`; -const getConfigureSnippet = (params: Params) => ` +const getConfigureSnippet = (params: DocsParams) => ` public static MauiApp CreateMauiApp() { var builder = MauiApp.CreateBuilder(); @@ -86,7 +77,7 @@ var span = transaction.StartChild("test-child-operation"); span.Finish(); // Mark the span as finished transaction.Finish(); // Mark the transaction as finished and send it to Sentry`; -const onboarding: OnboardingConfig = { +export const onboarding: OnboardingConfig = { install: params => [ { type: StepType.INSTALL, @@ -232,31 +223,3 @@ const onboarding: OnboardingConfig = { }, ], }; - -const crashReportOnboarding: OnboardingConfig = { - introduction: () => getCrashReportModalIntroduction(), - install: (params: Params) => getCrashReportGenericInstallSteps(params), - configure: () => [ - { - type: StepType.CONFIGURE, - content: [ - { - type: 'text', - text: getCrashReportModalConfigDescription({ - link: 'https://docs.sentry.io/platforms/dotnet/guides/maui/user-feedback/configuration/#crash-report-modal', - }), - }, - ], - }, - ], - verify: () => [], - nextSteps: () => [], -}; - -const docs: Docs = { - onboarding, - feedbackOnboardingCrashApi: csharpFeedbackOnboarding, - crashReportOnboarding, -}; - -export default docs;