From 23d165444b5f722ca3ce0ea9a871d838cb30ea4f Mon Sep 17 00:00:00 2001 From: Ryan Albrecht Date: Wed, 18 Dec 2024 10:02:51 -0800 Subject: [PATCH 1/3] docs: Add FAQ page for the Dev Toolbar --- docs/product/dev-toolbar/faq.mdx | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/product/dev-toolbar/faq.mdx diff --git a/docs/product/dev-toolbar/faq.mdx b/docs/product/dev-toolbar/faq.mdx new file mode 100644 index 0000000000000..67bc494db75ef --- /dev/null +++ b/docs/product/dev-toolbar/faq.mdx @@ -0,0 +1,15 @@ +--- +title: FAQ +sidebar_order: 30 +description: "Frequently asked questions about the Dev Toolbar." +--- + + + +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: + - 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. + - 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. + + From b321f50276bbcefecd8a34e454c3460eba4cc298 Mon Sep 17 00:00:00 2001 From: Ryan Albrecht Date: Wed, 18 Dec 2024 11:00:08 -0800 Subject: [PATCH 2/3] Update docs/product/dev-toolbar/faq.mdx Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> --- docs/product/dev-toolbar/faq.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/product/dev-toolbar/faq.mdx b/docs/product/dev-toolbar/faq.mdx index 67bc494db75ef..71065377c422f 100644 --- a/docs/product/dev-toolbar/faq.mdx +++ b/docs/product/dev-toolbar/faq.mdx @@ -9,7 +9,7 @@ description: "Frequently asked questions about the Dev Toolbar." 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: - - 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. + - The toolbar has a different set of [dependencies](https://github.com/getsentry/sentry-toolbar/blob/main/package.json) and uses different browser APIs that the JavaScript SDK does not use. For example: the toolbar will interact with things like cookies and local storage. 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. - 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. From e1cec7904bb541957831f3735efec8d8a53c942b Mon Sep 17 00:00:00 2001 From: Ryan Albrecht Date: Wed, 18 Dec 2024 11:24:09 -0800 Subject: [PATCH 3/3] note about ui vs sdk difference in goals --- docs/product/dev-toolbar/faq.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/product/dev-toolbar/faq.mdx b/docs/product/dev-toolbar/faq.mdx index 71065377c422f..74ee44433ad4f 100644 --- a/docs/product/dev-toolbar/faq.mdx +++ b/docs/product/dev-toolbar/faq.mdx @@ -9,6 +9,7 @@ description: "Frequently asked questions about the Dev Toolbar." 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: + - The toolbar is a UI product focused on making it easier to find and take action on existing data, while the SDK functions as infrastructure to collect and send data to the server. - The toolbar has a different set of [dependencies](https://github.com/getsentry/sentry-toolbar/blob/main/package.json) and uses different browser APIs that the JavaScript SDK does not use. For example: the toolbar will interact with things like cookies and local storage. 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. - 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.