Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add multi-view troubleshooting guide for sentry dart #11308

Merged
merged 18 commits into from
Nov 11, 2024
Merged

Add multi-view troubleshooting guide for sentry dart #11308

merged 18 commits into from
Nov 11, 2024

Conversation

martinhaintz
Copy link
Collaborator

DESCRIBE YOUR PR

Multi-view for web was introduced in Flutter 3.24. As the current sentry dart package is not 100% compatible with this feature I added a guide, how to use sentry with multi-view in Flutter web.

Flutter 3.24
Flutter Docs for multi-view

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel Vercel
Copy link

vercel bot commented Sep 10, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 11, 2024 9:16am
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 11, 2024 9:16am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 11, 2024 9:16am

@codecov Codecov
Copy link

codecov bot commented Sep 10, 2024 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 14.38MB (80.48%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name Size Change
sentry-docs-server* 7.44MB 7.44MB (100%) ⬆️⚠️
sentry-docs-edge-server* 254.43kB 254.43kB (100%) ⬆️⚠️
sentry-docs-client* 6.38MB 6.38MB (100%) ⬆️⚠️
sentry-docs-server-cjs 8.89MB 301.93kB (3.51%) ⬆️
sentry-docs-client-array-push 8.94MB 6 bytes (-0.0%) ⬇️

ℹ️ *Bundle size includes cached data from a previous commit

@martinhaintz martinhaintz requested review from denrase and buenaflor and removed request for denrase September 10, 2024 11:33
@martinhaintz martinhaintz marked this pull request as ready for review September 10, 2024 11:33
@martinhaintz martinhaintz mentioned this pull request Sep 10, 2024
Closed
6 tasks
buenaflor
buenaflor reviewed Sep 10, 2024
View reviewed changes
docs/platforms/flutter/troubleshooting.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/troubleshooting.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/troubleshooting.mdx Outdated Show resolved Hide resolved
@buenaflor buenaflor mentioned this pull request Sep 10, 2024
Closed
@martinhaintz martinhaintz enabled auto-merge (squash) September 11, 2024 07:52
@buenaflor
Copy link
Contributor

buenaflor commented Sep 26, 2024 •
edited
Loading

@martinhaintz pls see my latest comment and finish this pr

@buenaflor
Copy link
Contributor

@martinhaintz you need to merge in the latest changes from master, there has been a fix regarding the failing CI

buenaflor
buenaflor reviewed Sep 30, 2024
View reviewed changes
Copy link
Contributor

@buenaflor buenaflor left a comment

Choose a reason for hiding this comment

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

left 2 comments but looks good overall

docs/platforms/flutter/troubleshooting.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/troubleshooting.mdx Outdated Show resolved Hide resolved
mar-hai and others added 3 commits October 1, 2024 11:10
@mar-hai
Merge branch 'master' into martinhaintz/fix-flutter-multiview
b7f5dc3 
* master: (121 commits)
  Bump API schema to 1ce35106 (#11467)
  Bump API schema to fe37a3fa (#11465)
  Bump API schema to e9717315 (#11464)
  fix(remix): Add verify step to manual guide (#11463)
  Bump API schema to ff5880ca (#11457)
  docs(cron): Add note about luxon timezones (#11451)
  Bump API schema to f0e51113 (#11454)
  Add User Feedback alerts to main Alerts docs page (#11446)
  fix: Bun import (#11450)
  Bump API schema to d8309de0 (#11447)
  Update Intro to Sentry page (#11443)
  fix(releases): Document `release:latest` filter behaviour (#11423)
  Bump API schema to d6663c91 (#11442)
  feat(js): Document dataloaderIntegration released with 8.31.0 (#11416)
  docs(go): Add custom instrumentation page for tracing (#11429)
  ref(onboarding): Update word (#11440)
  feat(nuxt): Update server setup docs (#11415)
  Update docs on running getsentry locally (#11428)
  Callout to add .env to .gitignore #11430
  fix(dart): beforeSend code snippet (#11197)
  ...
@martinhaintz @buenaflor
Update docs/platforms/flutter/troubleshooting.mdx
2c30ea8 
Co-authored-by: Giancarlo Buenaflor <[email protected]>
@martinhaintz @buenaflor
Update docs/platforms/flutter/troubleshooting.mdx
7f7955b 
Co-authored-by: Giancarlo Buenaflor <[email protected]>
@martinhaintz
Copy link
Collaborator Author

@buenaflor I updated the docs according to this new PR

@martinhaintz
Copy link
Collaborator Author

@lizokm I have reverted my changes because the new PR will not be merged soon. I have implemented all your changes from your last review and this PR can be merged now.
However, the CI is failing with Vercel – changelog — Deployment has failed.
Is there something I can do from my side, to resolve this failing CI?

@kahest
Copy link
Member

kahest commented Oct 29, 2024

@martinhaintz you may need to merge in the latest changes from master again

@mar-hai
Merge branch 'master' into martinhaintz/fix-flutter-multiview
06c2123 
* master: (213 commits)
  Remove feature flag documentation from issue details page (#11734)
  docs(insights): Remove EA note from Queries re: MongoDB (#11735)
  docs(nuxt): `piniaIntegration` in Nuxt (#11684)
  feat(flags): Add OpenFeature and LaunchDarkly integration documentation (#11675)
  Cleaning up mermaid code and made it a bit more readable in dark mode (#11726)
  docs(scopes): Add graphics for scope forking (#11702)
  Unreal Engine plugin documentation update (#11625)
  Bump API schema to 25e528ff (#11728)
  Bump API schema to 12bd311c (#11725)
  fix dark theme resolution (#11718)
  Update sign in to go to sentry (#11723)
  getsentry/relay@4bdad17
  API examples syntax highlighting (#11715)
  feat: Convert mermaid code blocks to SVGs client side (#11690)
  Trace context is required for transactions (#11456)
  deps: Bump SDK to 8.36.0 (#11696)
  getsentry/relay@2e2587c
  MAUI screenshot `SetBeforeScreenshotCapture`(#11672)
  Add CSS rule to fix color of bold links (#11707)
  Fix small typo on web-vitals-concepts (#11706)
  ...
@mar-hai
Merge branch 'master' into martinhaintz/fix-flutter-multiview
05f8102 
* master: (39 commits)
  getsentry/relay@403f2bf
  feat(native): add backend trade-offs to Advanced Usage (#11721)
  🔧 chore(api): add additional troubleshooting instructions to publish api docs (#11772)
  Bump API schema to 02adb960 (#11773)
  Update metric-alert-config.mdx (#11760)
  update w-9 tax form (#11764)
  chore: silence fetch cache error due to size limit (#11767)
  fix Ureal engine DSN placeholder (#11769)
  feat: Banner pathname regex (#11761)
  docs(nuxt): Add troubleshoot pnpm (#11720)
  Docker Desktop to Colima fix (#11752)
  Bump API schema to d51784a6 (#11759)
  ref(feedback): update user feedback docs to include external issue linking & auto issue creation (#11729)
  getsentry/relay@d23c39a
  Changed /store to /envelope (because /store does not exist anymore (#11755)
  Refactor arcade embeds (#11722)
  feat(js): Add `skipBrowserExtensionCheck` documentation (#11693)
  getsentry/relay@a7d9096
  fix mermaid charts in dark mode (#11754)
  fix: Log4j configurations and wording (#11395)
  ...
buenaflor
buenaflor approved these changes Nov 11, 2024
View reviewed changes
Copy link
Contributor

@buenaflor buenaflor left a comment

Choose a reason for hiding this comment

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

I think this is ok now, we have a draft PR that can automatically detect if it's multiview

This won't be merged now due to lack of tests but once it is merged this doc needs to be changed or maybe even removed

@martinhaintz martinhaintz merged commit 0817b9e into master Nov 11, 2024
11 checks passed
@martinhaintz martinhaintz deleted the martinhaintz/fix-flutter-multiview branch November 11, 2024 10:32
vaind pushed a commit that referenced this pull request Nov 11, 2024
@martinhaintz @mar-hai
@buenaflor @kahest @lizokm @vaind
Add multi-view troubleshooting guide for sentry dart (#11308)
1c2ffae 
* add multi-view troubleshooting guide for sentry dart

* remove unused code

* rephrase text and split up in general and example app related part.

* add complete example application instead of sentry example app adaptation

* Update docs/platforms/flutter/troubleshooting.mdx

Co-authored-by: Giancarlo Buenaflor <[email protected]>

* Update docs/platforms/flutter/troubleshooting.mdx

Co-authored-by: Giancarlo Buenaflor <[email protected]>

* Update includes/troubleshooting/flutter/enable_multi_view.mdx

Co-authored-by: Karl Heinz Struggl <[email protected]>

* Update docs/platforms/flutter/troubleshooting.mdx

Co-authored-by: Karl Heinz Struggl <[email protected]>

* Update docs/platforms/flutter/troubleshooting.mdx

Co-authored-by: Liza Mock <[email protected]>

* Update docs/platforms/flutter/troubleshooting.mdx

Co-authored-by: Liza Mock <[email protected]>

* Update docs/platforms/flutter/troubleshooting.mdx

Co-authored-by: Liza Mock <[email protected]>

* Update docs/platforms/flutter/troubleshooting.mdx

Co-authored-by: Liza Mock <[email protected]>

* Update includes/troubleshooting/flutter/enable_multi_view.mdx

Co-authored-by: Liza Mock <[email protected]>

* update to match the latest PR

* revert changes to previous commit.

---------

Co-authored-by: Martin Haintz <[email protected]>
Co-authored-by: Giancarlo Buenaflor <[email protected]>
Co-authored-by: Karl Heinz Struggl <[email protected]>
Co-authored-by: Liza Mock <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@p-mazhnik p-mazhnik p-mazhnik left review comments

@kahest kahest kahest left review comments

@buenaflor buenaflor buenaflor approved these changes

@lizokm lizokm Awaiting requested review from lizokm

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@martinhaintz @buenaflor @kahest @p-mazhnik @lizokm @mar-hai