feat(toolbar): Add setup instructions for the Sentry Toolbar using the react hook useSentryToolbar #12845
Conversation
…eact hook useSentryToolbar
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 84 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
docs/product/dev-toolbar/faq.mdx
Outdated
| @@ -4,6 +4,55 @@ sidebar_order: 30 | |||
| description: "Frequently asked questions about the Dev Toolbar." | |||
| --- | |||
|
|
|||
| <Expandable title="In what environments should I enable the Dev Toolbar?"> | |||
There was a problem hiding this comment.
I had suggested to name the npm package developer toolbar (I don't have strong feels about it), but if "Dev Toolbar" is the official product name for it, we should make the npm package name match.
(why can't this be "Sentry Toolbar", does it need dev at all?)
There was a problem hiding this comment.
renaming the thing makes sense. the repo is called sentry-toolbar already.
I think using development, especially in the npm package name, was meant to make it not sound like an environment or a dev/alpha/beta tag. A proper rename avoids any confusion in that area.
There was a problem hiding this comment.
Put up a rename PR: getsentry/sentry-toolbar#223
The current state is that the npm publish of @sentry/developer-toolbar (the old name) isn't complete yet, there's a bug in the pipeline.
I've asked for help with that pipeline bug, so if it's not disruptive to debugging we can land the rename name. I'll check in on that. Otherwise I might just keep working at that pipeline problem first which means we will publish the old name once. After that's working we can land the rename.
docs/product/dev-toolbar/faq.mdx
Outdated
| - In production environments, do not initialize the Toolbar. | ||
|
|
||
| Initializing the Dev Toolbar allows all developers and testers can use it and quickly go from the page they're looking at back to Sentry for further debugging. | ||
| In production it can make it easier for developers to reproduce issues, but it should not be initialized for all users of the site -- only when an employee/engineer/etc visits. |
There was a problem hiding this comment.
Feels like this warrants an alert-style component
ryan953
changed the title
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
This adds some information about the new react hook
useSentryToolbarto the Toolbar Setup instructions, and tries to streamline the instructions in the process (it was getting crazy talking about CDN and react at the same time).Some of that streamlining is because I moved some content out to the FAQ and linked to it, instead of including it on the setup page.
The pages you can checkout in the preview build are:
Depends on getsentry/sentry-toolbar#223 being published to npm.