Browse Source

feat(feedback): add web api platforms to issues feedback sidebar (#66486)

- these platforms all use the web API for onboarding

this PR adds the instructions for
- minidump
- native
- native-qt
- ruby
- ruby-rack
<img width="464" alt="SCR-20240306-nzex"
src="https://github.com/getsentry/sentry/assets/56095982/e80caa51-1670-42d7-9e29-3ff424599eb9">

relates to https://github.com/getsentry/sentry/issues/66162
Michelle Zhang 1 year ago
parent
commit
4ecb4f24d1

+ 4 - 0
static/app/components/feedback/feedbackOnboarding/useLoadFeedbackOnboardingDoc.tsx

@@ -22,6 +22,10 @@ function getPlatformPath(platform: PlatformIntegration) {
         return `unreal/unreal`;
         return `unreal/unreal`;
       case 'unity':
       case 'unity':
         return `unity/unity`;
         return `unity/unity`;
+      case 'minidump':
+        return `minidump/minidump`;
+      case 'native-qt':
+        return `native/native-qt`;
       default:
       default:
         return platform.id.replace(`${platform.language}-`, `${platform.language}/`);
         return platform.id.replace(`${platform.language}-`, `${platform.language}/`);
     }
     }

+ 9 - 0
static/app/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding.tsx

@@ -1,6 +1,7 @@
 import Alert from 'sentry/components/alert';
 import Alert from 'sentry/components/alert';
 import ExternalLink from 'sentry/components/links/externalLink';
 import ExternalLink from 'sentry/components/links/externalLink';
 import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
 import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
+import type {OnboardingConfig} from 'sentry/components/onboarding/gettingStartedDoc/types';
 import {t, tct} from 'sentry/locale';
 import {t, tct} from 'sentry/locale';
 
 
 export const getFeedbackConfigureDescription = ({
 export const getFeedbackConfigureDescription = ({
@@ -67,6 +68,14 @@ export function FeedbackOnboardingWebApiBanner() {
   );
   );
 }
 }
 
 
+export const CrashReportWebApiOnboarding: OnboardingConfig = {
+  introduction: () => FeedbackOnboardingWebApiBanner(),
+  install: () => [],
+  configure: () => [],
+  verify: () => [],
+  nextSteps: () => [],
+};
+
 export const getFeedbackConfigOptions = ({
 export const getFeedbackConfigOptions = ({
   name,
   name,
   email,
   email,

+ 2 - 0
static/app/gettingStartedDocs/minidump/minidump.tsx

@@ -8,6 +8,7 @@ import type {
   DocsParams,
   DocsParams,
   OnboardingConfig,
   OnboardingConfig,
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
+import {CrashReportWebApiOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
 import {t, tct} from 'sentry/locale';
 import {t, tct} from 'sentry/locale';
 
 
 type Params = DocsParams;
 type Params = DocsParams;
@@ -76,6 +77,7 @@ const onboarding: OnboardingConfig = {
 
 
 const docs: Docs = {
 const docs: Docs = {
   onboarding,
   onboarding,
+  crashReportOnboarding: CrashReportWebApiOnboarding,
 };
 };
 
 
 export default docs;
 export default docs;

+ 2 - 0
static/app/gettingStartedDocs/native/native-qt.tsx

@@ -7,6 +7,7 @@ import type {
   DocsParams,
   DocsParams,
   OnboardingConfig,
   OnboardingConfig,
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
+import {CrashReportWebApiOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
 import {t, tct} from 'sentry/locale';
 import {t, tct} from 'sentry/locale';
 
 
 type Params = DocsParams;
 type Params = DocsParams;
@@ -106,6 +107,7 @@ const onboarding: OnboardingConfig = {
 
 
 const docs: Docs = {
 const docs: Docs = {
   onboarding,
   onboarding,
+  crashReportOnboarding: CrashReportWebApiOnboarding,
 };
 };
 
 
 export default docs;
 export default docs;

+ 2 - 0
static/app/gettingStartedDocs/native/native.tsx

@@ -7,6 +7,7 @@ import type {
   DocsParams,
   DocsParams,
   OnboardingConfig,
   OnboardingConfig,
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
+import {CrashReportWebApiOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
 import {t, tct} from 'sentry/locale';
 import {t, tct} from 'sentry/locale';
 
 
 type Params = DocsParams;
 type Params = DocsParams;
@@ -102,6 +103,7 @@ const onboarding: OnboardingConfig = {
 
 
 const docs: Docs = {
 const docs: Docs = {
   onboarding,
   onboarding,
+  crashReportOnboarding: CrashReportWebApiOnboarding,
 };
 };
 
 
 export default docs;
 export default docs;

+ 2 - 0
static/app/gettingStartedDocs/ruby/rack.tsx

@@ -4,6 +4,7 @@ import type {
   DocsParams,
   DocsParams,
   OnboardingConfig,
   OnboardingConfig,
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
+import {CrashReportWebApiOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
 import {tct} from 'sentry/locale';
 import {tct} from 'sentry/locale';
 
 
 type Params = DocsParams;
 type Params = DocsParams;
@@ -67,6 +68,7 @@ const onboarding: OnboardingConfig = {
 
 
 const docs: Docs = {
 const docs: Docs = {
   onboarding,
   onboarding,
+  crashReportOnboarding: CrashReportWebApiOnboarding,
 };
 };
 
 
 export default docs;
 export default docs;

+ 2 - 0
static/app/gettingStartedDocs/ruby/ruby.tsx

@@ -4,6 +4,7 @@ import type {
   DocsParams,
   DocsParams,
   OnboardingConfig,
   OnboardingConfig,
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
+import {CrashReportWebApiOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
 import {t, tct} from 'sentry/locale';
 import {t, tct} from 'sentry/locale';
 
 
 type Params = DocsParams;
 type Params = DocsParams;
@@ -79,6 +80,7 @@ const onboarding: OnboardingConfig = {
 
 
 const docs: Docs = {
 const docs: Docs = {
   onboarding,
   onboarding,
+  crashReportOnboarding: CrashReportWebApiOnboarding,
 };
 };
 
 
 export default docs;
 export default docs;