sentry icon indicating copy to clipboard operation
sentry copied to clipboard

ref(onboarding): Consolidate ionic and capacitor docs

Open priscilawebdev opened this issue 1 year ago • 5 comments

Problem

In our user feedback product, we currently display capacitor getting started documentation even when ionic is selected. This results from the strong integration between ionic and capacitor, which are commonly used together and share the same Sentry SDK configuration.

However, inconsistencies exist in how we present the ionic documentation between user feedback and the main onboarding process:

  • The user feedback documentation offers additional features such as selecting a sibling framework (Angular 12+, React, Vue, etc.), whereas the onboarding documentation for ionic does not provide these options.
  • The onboarding documentation for capacitor allows users to opt-in or opt-out of performance and replay products, whereas the onboarding documentation for ionic lacks these options.

Solution

To address these issues, we propose removing the ionic getting started documentation entirely. Instead, when users select ionic as their platform during the main onboarding process, we will integrate the capacitor documentation. This approach will ensure consistency across platforms and provide users with uniform options for integrating performance and replay functionalities.

priscilawebdev avatar Jun 28 '24 09:06 priscilawebdev

@lucas-zimerman, I was wondering if we don't need to add new in front of SentrySibling. Does it create an instance without it? I mean it is a pseudo code but....

Screenshot 2024-06-28 at 11 27 37

priscilawebdev avatar Jun 28 '24 09:06 priscilawebdev

Codecov Report

Attention: Patch coverage is 38.46154% with 8 lines in your changes missing coverage. Please review.

Project coverage is 78.11%. Comparing base (479ea5a) to head (793103b).

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #73496   +/-   ##
=======================================
  Coverage   78.11%   78.11%           
=======================================
  Files        6661     6660    -1     
  Lines      298052   298051    -1     
  Branches    51281    51285    +4     
=======================================
+ Hits       232832   232837    +5     
+ Misses      58931    58856   -75     
- Partials     6289     6358   +69     
Files Coverage Δ
...tic/app/components/onboarding/productSelection.tsx 84.00% <ø> (+4.00%) :arrow_up:
...tic/app/gettingStartedDocs/capacitor/capacitor.tsx 54.43% <38.46%> (-3.15%) :arrow_down:

... and 113 files with indirect coverage changes

codecov[bot] avatar Jun 28 '24 09:06 codecov[bot]

@lucas-zimerman Also, just to be absolutely sure:

We didn't display the information about uploading source maps for ionic before... I assume that since everything now is a capacitor, it does not matter right?

Before for ionic: image

After for ionic: image

priscilawebdev avatar Jun 28 '24 09:06 priscilawebdev

hey @ArthurKnaus thank you for your review!

Yes, I plan to focus on cleaning up the code in future PRs 🙂

priscilawebdev avatar Jun 28 '24 09:06 priscilawebdev

Bundle Report

Changes will increase total bundle size by 9.62kB :arrow_up:

Bundle name Size Change
app-webpack-bundle-array-push 27.32MB 9.62kB :arrow_up:

codecov[bot] avatar Jun 28 '24 15:06 codecov[bot]

@lucas-zimerman, I was wondering if we don't need to add new in front of SentrySibling. Does it create an instance without it? I mean it is a pseudo code but....

Screenshot 2024-06-28 at 11 27 37

for browserTracingIntegration new is not needed, despite being on V7, this specific integration initializes the same way on both V7 and V8.

lucas-zimerman avatar Jul 05 '24 02:07 lucas-zimerman

We didn't display the information about uploading source maps for ionic before... I assume that since everything now is a capacitor, it does not matter right?

Looks good to me, the same method for uploading source-maps also applies to ionic

lucas-zimerman avatar Jul 05 '24 02:07 lucas-zimerman