-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs: Add FAQ page for the Dev Toolbar #12182
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
23d1654
docs: Add FAQ page for the Dev Toolbar
ryan953 b321f50
Update docs/product/dev-toolbar/faq.mdx
ryan953 e1cec79
note about ui vs sdk difference in goals
ryan953 8c29447
Apply suggestions from code review
ryan953 217da87
Update docs/product/dev-toolbar/faq.mdx
ryan953 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| title: FAQ | ||
| sidebar_order: 30 | ||
| description: "Frequently asked questions about the Dev Toolbar." | ||
| --- | ||
|
|
||
| <Expandable title="Are there plans to include the Dev Toolbar in the JavaScript SDK?"> | ||
|
|
||
| The the Dev Toolbar is very distinct from the JavaScript SDK and will not be merged into the [JavaScript SDK](https://github.com/getsentry/sentry-javascript). | ||
|
|
||
| Some of the differences include: | ||
ryan953 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - The toolbar has a different set of [dependencies](https://github.com/getsentry/sentry-toolbar/blob/main/package.json) and uses different browser API's that the JavaScript SDK does not use. For example: the toolbar will interact with things like cookies and localstorage. By keeping these pieces of code separate it is easier to audit the [SDK code on github](https://github.com/getsentry/sentry-javascript) to verify that it is not persisting information inside end-users browsers. | ||
ryan953 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - The setup & deploy instruction are very different. The SDK is best deployed on staging and production environments, and can be configured easily with environment variables. The Dev Toolbar requires special considerations to deploy it into production, usually by creating a condition so that it's only included for members of your own Sentry organization. This is why it's important to keep the setup instructions separate between the two. | ||
ryan953 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| </Expandable> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.