Skip to content

Commit 65c490a

Browse files
priscilawebdevandrewshie-sentry
authored andcommitted
ref(onboarding): Split xamarin onboarding docs (#102936)
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms
1 parent f815425 commit 65c490a

File tree

4 files changed

+47
-44
lines changed

4 files changed

+47
-44
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import type {OnboardingConfig} from 'sentry/components/onboarding/gettingStartedDoc/types';
2+
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/types';
3+
import {
4+
getCrashReportGenericInstallSteps,
5+
getCrashReportModalConfigDescription,
6+
getCrashReportModalIntroduction,
7+
} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
8+
9+
export const crashReport: OnboardingConfig = {
10+
introduction: () => getCrashReportModalIntroduction(),
11+
install: params => getCrashReportGenericInstallSteps(params),
12+
configure: () => [
13+
{
14+
type: StepType.CONFIGURE,
15+
content: [
16+
{
17+
type: 'text',
18+
text: getCrashReportModalConfigDescription({
19+
link: 'https://docs.sentry.io/platforms/dotnet/guides/xamarin/user-feedback/configuration/#crash-report-modal',
20+
}),
21+
},
22+
],
23+
},
24+
],
25+
verify: () => [],
26+
nextSteps: () => [],
27+
};
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types';
2+
import {feedback} from 'sentry/gettingStartedDocs/dotnet/dotnet/feedback';
3+
4+
import {crashReport} from './crashReport';
5+
import {onboarding} from './onboarding';
6+
7+
const docs: Docs = {
8+
onboarding,
9+
feedbackOnboardingCrashApi: feedback,
10+
crashReportOnboarding: crashReport,
11+
};
12+
13+
export default docs;

static/app/gettingStartedDocs/dotnet/xamarin.spec.tsx renamed to static/app/gettingStartedDocs/dotnet/xamarin/onboarding.spec.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {renderWithOnboardingLayout} from 'sentry-test/onboarding/renderWithOnboa
22
import {screen} from 'sentry-test/reactTestingLibrary';
33
import {textWithMarkupMatcher} from 'sentry-test/utils';
44

5-
import docs from './xamarin';
5+
import docs from './index';
66

77
describe('xamarin onboarding docs', () => {
88
it('renders errors onboarding docs correctly', async () => {

static/app/gettingStartedDocs/dotnet/xamarin.tsx renamed to static/app/gettingStartedDocs/dotnet/xamarin/onboarding.tsx

Lines changed: 6 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,27 @@
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 {
9-
getCrashReportGenericInstallSteps,
10-
getCrashReportModalConfigDescription,
11-
getCrashReportModalIntroduction,
12-
} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
13-
import {feedback} from 'sentry/gettingStartedDocs/dotnet/dotnet/feedback';
147
import {t, tct} from 'sentry/locale';
158
import {getPackageVersion} from 'sentry/utils/gettingStartedDocs/getPackageVersion';
169

17-
type Params = DocsParams;
18-
19-
const getInstallSnippetXamarin = (params: Params) => `
10+
const getInstallSnippetXamarin = (params: DocsParams) => `
2011
Install-Package Sentry.Xamarin -Version ${getPackageVersion(
2112
params,
2213
'sentry.dotnet.xamarin',
2314
'1.5.2'
2415
)}`;
2516

26-
const getInstallSnippetXamarinForms = (params: Params) => `
17+
const getInstallSnippetXamarinForms = (params: DocsParams) => `
2718
Install-Package Sentry.Xamarin.Forms -Version ${getPackageVersion(
2819
params,
2920
'sentry.dotnet.xamarin-forms',
3021
'1.5.2'
3122
)}`;
3223

33-
const getConfigureSnippetAndroid = (params: Params) => `
24+
const getConfigureSnippetAndroid = (params: DocsParams) => `
3425
public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity
3526
{
3627
protected override void OnCreate(Bundle savedInstanceState)
@@ -48,7 +39,7 @@ public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompa
4839
options.AddXamarinFormsIntegration();
4940
});`;
5041

51-
const getConfigureSnippetIOS = (params: Params) => `
42+
const getConfigureSnippetIOS = (params: DocsParams) => `
5243
public partial class AppDelegate : global::Xamarin.Forms.Platform.iOS.FormsApplicationDelegate
5344
{
5445
public override bool FinishedLaunching(UIApplication app, NSDictionary options)
@@ -64,7 +55,7 @@ public partial class AppDelegate : global::Xamarin.Forms.Platform.iOS.FormsAppli
6455
options.AddXamarinFormsIntegration();
6556
});`;
6657

67-
const getConfigureSnippetUWP = (params: Params) => `
58+
const getConfigureSnippetUWP = (params: DocsParams) => `
6859
sealed partial class App : Application
6960
{
7061
protected override void OnLaunched(LaunchActivatedEventArgs e)
@@ -97,7 +88,7 @@ var span = transaction.StartChild("test-child-operation");
9788
span.Finish(); // Mark the span as finished
9889
transaction.Finish(); // Mark the transaction as finished and send it to Sentry`;
9990

100-
const onboarding: OnboardingConfig = {
91+
export const onboarding: OnboardingConfig = {
10192
install: params => [
10293
{
10394
type: StepType.INSTALL,
@@ -283,31 +274,3 @@ const onboarding: OnboardingConfig = {
283274
},
284275
],
285276
};
286-
287-
const crashReportOnboarding: OnboardingConfig = {
288-
introduction: () => getCrashReportModalIntroduction(),
289-
install: (params: Params) => getCrashReportGenericInstallSteps(params),
290-
configure: () => [
291-
{
292-
type: StepType.CONFIGURE,
293-
content: [
294-
{
295-
type: 'text',
296-
text: getCrashReportModalConfigDescription({
297-
link: 'https://docs.sentry.io/platforms/dotnet/guides/xamarin/user-feedback/configuration/#crash-report-modal',
298-
}),
299-
},
300-
],
301-
},
302-
],
303-
verify: () => [],
304-
nextSteps: () => [],
305-
};
306-
307-
const docs: Docs = {
308-
onboarding,
309-
feedbackOnboardingCrashApi: feedback,
310-
crashReportOnboarding,
311-
};
312-
313-
export default docs;

0 commit comments

Comments
 (0)