Skip to content

Conversation

@imatwawana
Copy link
Contributor

@imatwawana imatwawana commented Feb 7, 2022

Refactors Dart docs to match other SDK documentation.

  • Updated getting started primer
  • Moved automatic breadcrumbs content from Advanced Usage page into an include
  • Updated capture-error include with Tips for Catching Errors content from Advanced Usage page to accommodate shared content between Dart and Flutter
  • Updated wizard
  • Deleted Dart index page
  • Renamed Advanced Usage page HTTP Integration and moved it into new Integrations folder
  • Added Integrations index page

Closes #3197

@vercel
Copy link

vercel bot commented Feb 7, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sentry/sentry-docs/BDgP9gBax8r79PSFf4ZxVETcjk3h
✅ Preview: https://sentry-docs-git-update-restructure-dart-docs.sentry.dev

@imatwawana imatwawana linked an issue Feb 7, 2022 that may be closed by this pull request
@imatwawana
Copy link
Contributor Author

@marandaneto - I've started on this but it needs review/collab. I've used the Flutter restructure that was done a while back as my guide. A few initial questions/issues:

  1. I did what made sense to me in the getting-started-primer, but the feature list definitely needs review.
  2. I moved what I could out of the Advanced Usage page, but I don't know what to do with the remaining content.
  3. Looking at the Flutter restructure that was done before, I'm not sure if there are any updates required to the Basic Options page under configuration
  4. This file isn't here because I didn't touch it, but in the Flutter restructure, there's a platform section around line 15 of /common/enriching-events/tags that's notSupported for flutter; should that be the case for Dart as well?
  5. Are we missing Debug Symbols and Troubleshooting content?

@imatwawana imatwawana changed the title Update/restructure dart docs restructure dart docs Feb 7, 2022
@marandaneto
Copy link
Contributor

@marandaneto - I've started on this but it needs review/collab. I've used the Flutter restructure that was done a while back as my guide. A few initial questions/issues:

  1. I did what made sense to me in the getting-started-primer, but the feature list definitely needs review.

I've added comments to the change.

  1. I moved what I could out of the Advanced Usage page, but I don't know what to do with the remaining content.

The remaining is about an HTTP integration, that could go to the integration list, similar to Android
This page does not exist yet, it'd need to be created.

  1. Looking at the Flutter restructure that was done before, I'm not sure if there are any updates required to the Basic Options page under configuration

That looks good for now.

  1. This file isn't here because I didn't touch it, but in the Flutter restructure, there's a platform section around line 15 of /common/enriching-events/tags that's notSupported for flutter; should that be the case for Dart as well?

I believe we could remove flutter from there, both SDKs are supported.

  1. Are we missing Debug Symbols and Troubleshooting content?

Debug Symbols I don't think so, at least yet, the use case for debug symbols is only for Flutter afaik.

Troubleshooting also only has content for Flutter apps yet.

@imatwawana
Copy link
Contributor Author

@marandaneto - I've tried to address all your feedback, but the folder structure I've created for the HTTP Integration page doesn't seem to be working and I'm not sure why. @bruno-garcia, can you see what the problem is there?

@marandaneto
Copy link
Contributor

@marandaneto - I've tried to address all your feedback, but the folder structure I've created for the HTTP Integration page doesn't seem to be working and I'm not sure why. @bruno-garcia, can you see what the problem is there?

Feedback is addressed, all good.

The problem is that the link https://sentry-docs-git-update-restructure-dart-docs.sentry.dev/platforms/dart/configuration/integrations/http-integration/#performance-monitoring-for-http-requests does not exist, actually, the Integrations menu does not exist appear under the Configuration menu -> https://sentry-docs-git-update-restructure-dart-docs.sentry.dev/platforms/dart/configuration/

So there's something wrong with the Integrations subpage setup.

@imatwawana imatwawana marked this pull request as ready for review February 25, 2022 16:10
@imatwawana imatwawana requested a review from a team as a code owner February 25, 2022 16:10
Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com>
Copy link
Contributor

@marandaneto marandaneto left a comment

Choose a reason for hiding this comment

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

@imatwawana thanks for doing this, appreciate it.

@marandaneto marandaneto merged commit 3d41688 into master Feb 26, 2022
@marandaneto marandaneto deleted the update/restructure-dart-docs branch February 26, 2022 07:31
@github-actions github-actions bot locked and limited conversation to collaborators Mar 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Dart Docs

3 participants