docs(js): Update content in SvelteKit's manual quick start guide (source maps, csp) #13843

inventarSarah · 2025-05-27T10:18:38Z

DESCRIBE YOUR PR

In this PR I have:

reduced the source maps content in SvelteKit's manual quick start guide and moved it to the Source Maps page
moved content about CSP to the Troubleshooting page and added an Expandable to the manual quick start guide

I will move the build options and API content in a new PR (or two) to keep things focused.

Belongs to: #13634

IS YOUR CHANGE URGENT?

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+

SLA

Teamwork makes the dream work, so please add a reviewer to your PRs.
Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
Thanks in advance for your help!

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

EXTRA RESOURCES

Sentry Docs contributor guide

vercel · 2025-05-27T10:18:44Z

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

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 2, 2025 8:30am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		Jun 2, 2025 8:30am
develop-docs	⬜️ Ignored (Inspect)	Visit Preview		Jun 2, 2025 8:30am

Lms24

Thanks! The CSP section looks great already. I had a concern about the source maps configuration settings (see comments). TLDR: We should never set the auth token in code but only as env variables.

Realizing that the comment order in my review is a bit misleading for source maps. I recommend reading #13843 (comment) first :)

docs/platforms/javascript/common/troubleshooting/index.mdx

platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx

Lms24 · 2025-05-27T14:34:54Z

platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx

+However, you still need to specify your Sentry auth token as well as your org and project slugs.
+There are two ways to set them:
+
+**Option 1**


m: The options here really only differ in how much users set as env variables vs. directly in code. Users can set project and org slugs in code but they should never set the auth token in code as it must remain a secret and shouldn't be committed.

So I'd recommend we:

always show the .env file for setting the SENTRY_AUTH_TOKEN

also show a complete .env file for option 1 (see my comment)

show both .env and vite.config.ts for option 2 (basically how we used to show it in manual setup).

Does this make sense?

Thanks for bringing this up -- I think I understood what you meant -> let me know if you have feedback on the changes.

I'll review the other SDKs to see whether we need to update this there as well next week. It would be ideal to be consistent here.

platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx

…eltekit/clean-up-manual-qs

codecov · 2025-05-28T08:19:14Z

Bundle Report

Changes will increase total bundle size by 465 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
sentry-docs-server-cjs	11.22MB	471 bytes (0.0%) ⬆️
sentry-docs-client-array-push	9.77MB	-6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`static/chunks/pages/_app-*.js`	-3 bytes	868.7kB	-0.0%
`static/chunks/8165-*.js`	-3 bytes	410.1kB	-0.0%
`static/CTAoPRftGKDT_KABYsQV1/_buildManifest.js` (New)	616 bytes	616 bytes	100.0% 🚀
`static/CTAoPRftGKDT_KABYsQV1/_ssgManifest.js` (New)	77 bytes	77 bytes	100.0% 🚀
~~`static/MG13B8iZHzogkhfyu30qQ/_buildManifest.js`~~ (Deleted)	-616 bytes	0 bytes	-100.0% 🗑️
~~`static/MG13B8iZHzogkhfyu30qQ/_ssgManifest.js`~~ (Deleted)	-77 bytes	0 bytes	-100.0% 🗑️

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`1729.js`	-3 bytes	1.75MB	-0.0%
`../instrumentation.js`	-3 bytes	1.08MB	-0.0%
`9523.js`	-3 bytes	1.05MB	-0.0%
`../app/[[...path]]/page.js.nft.json`	160 bytes	399.59kB	0.04%
`../app/platform-redirect/page.js.nft.json`	160 bytes	399.51kB	0.04%
`../app/sitemap.xml/route.js.nft.json`	160 bytes	397.48kB	0.04%

Lms24 · 2025-05-28T08:42:58Z

platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx

+      sourceMapsUploadOptions: {
+        org: "___ORG_SLUG___",
+        project: "___PROJECT_SLUG___",
+        authToken: "process.env.SENTRY_AUTH_TOKEN",


this shouldn't be a string:

Suggested change

authToken: "process.env.SENTRY_AUTH_TOKEN",

authToken: process.env.SENTRY_AUTH_TOKEN,

Lms24 · 2025-05-28T08:45:27Z

platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx

+
+You can also set your org and project slugs by passing a `sourceMapsUploadOptions` object to `sentrySvelteKit`, as seen in the example below. For a full list of available options, see the [Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin#options).
+
+<OrgAuthTokenNote />


I think we should still show the auth token in the .env file here, given that the token needs to be set somewhere. Otherwise, we should at least remove the <OrgAuthTokenNote> here.

Suggested change

<OrgAuthTokenNote />

<OrgAuthTokenNote />

\```bash {filename:.env}

# DO NOT commit this file to your repo. The auth token is a secret.

SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___

\```

(please ignore the backslashes, GH makes suggesting code blocks impossible :(

👍
I added the .env file here as suggested - thank you!

In Option 1, I also added OrgAuthTokenNote above the .env file

Lms24 · 2025-05-28T08:49:02Z

docs/platforms/javascript/guides/sveltekit/manual-setup.mdx

-          ignore: ["**/build/client/**/*"],
-          filesToDeleteAfterUpload: ["./build/**/*.map"],
-        },
+        authToken: "___ORG_AUTH_TOKEN___",


I realized we have the same problem here. We also shouldn't directly put the auth token into code here. I actually liked the previous version where we basically showed option 2. Happy to leave it up to you if it makes more sense to display both files in tabs in the same code block or one underneath the other.

💯
Updated this section and added the .env with the auth token.
In general, it is best to provide only one option in a quick start guide, allowing the user to focus on setting things up quickly.

docs/platforms/javascript/common/troubleshooting/index.mdx

docs/platforms/javascript/guides/sveltekit/manual-setup.mdx

coolguyzone

Looks good! Please address the step number comment before merging

…eltekit/clean-up-manual-qs

Lms24

Thanks for including my suggestions! LGTM!

…rce maps, csp) (#13843)  ## DESCRIBE YOUR PR In this PR I have: - reduced the source maps content in SvelteKit's manual quick start guide and moved it to the Source Maps page - moved content about CSP to the Troubleshooting page and added an Expandable to the manual quick start guide I will move the build options and API content in a new PR (or two) to keep things focused. Belongs to: #13634 ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.):  - [ ] Other deadline:  - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## 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](https://github.com/orgs/getsentry/teams/docs) ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

inventarSarah added 2 commits May 27, 2025 10:55

clean up source maps content

682378d

clean up CSP content

06da45d

inventarSarah requested review from Lms24, chargome and coolguyzone May 27, 2025 10:18

vercel bot deployed to Preview – sentry-docs May 27, 2025 10:23 View deployment

Lms24 reviewed May 27, 2025

View reviewed changes

inventarSarah added 2 commits May 28, 2025 09:55

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/sv…

aa7f6e2

…eltekit/clean-up-manual-qs

PR feedback

3e00895

vercel bot deployed to Preview – sentry-docs May 28, 2025 08:29 View deployment

Lms24 reviewed May 28, 2025

View reviewed changes

coolguyzone reviewed May 29, 2025

View reviewed changes

docs/platforms/javascript/common/troubleshooting/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed May 29, 2025

View reviewed changes

docs/platforms/javascript/common/troubleshooting/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed May 29, 2025

View reviewed changes

docs/platforms/javascript/common/troubleshooting/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed May 29, 2025

View reviewed changes

docs/platforms/javascript/guides/sveltekit/manual-setup.mdx Show resolved Hide resolved

coolguyzone approved these changes May 29, 2025

View reviewed changes

inventarSarah added 2 commits June 2, 2025 08:41

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/sv…

6f3ecb0

…eltekit/clean-up-manual-qs

pr feedback

11eeccf

vercel bot deployed to Preview – sentry-docs June 2, 2025 07:36 View deployment

add comment to auth token

18692a3

vercel bot deployed to Preview – sentry-docs June 2, 2025 08:30 View deployment

Lms24 approved these changes Jun 2, 2025

View reviewed changes

inventarSarah merged commit a4857f7 into master Jun 2, 2025
13 checks passed

inventarSarah deleted the smi/sveltekit/clean-up-manual-qs branch June 2, 2025 12:32

	authToken: "process.env.SENTRY_AUTH_TOKEN",
	authToken: process.env.SENTRY_AUTH_TOKEN,


		You can also set your org and project slugs by passing a `sourceMapsUploadOptions` object to `sentrySvelteKit`, as seen in the example below. For a full list of available options, see the [Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin#options).

		<OrgAuthTokenNote />

-<OrgAuthTokenNote />
+<OrgAuthTokenNote />
+\```bash {filename:.env}
+# DO NOT commit this file to your repo. The auth token is a secret.
+SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___
+\```

Uh oh!

docs(js): Update content in SvelteKit's manual quick start guide (source maps, csp) #13843

docs(js): Update content in SvelteKit's manual quick start guide (source maps, csp) #13843

Uh oh!

Conversation

inventarSarah commented May 27, 2025

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

EXTRA RESOURCES

Uh oh!

vercel bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Lms24 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lms24 May 27, 2025

Choose a reason for hiding this comment

Uh oh!

inventarSarah May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Assets Changed:

Uh oh!

Lms24 May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Lms24 May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

inventarSarah Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

Lms24 May 28, 2025

Choose a reason for hiding this comment

Uh oh!

inventarSarah Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coolguyzone left a comment

Choose a reason for hiding this comment

Uh oh!

Lms24 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vercel bot commented May 27, 2025 •

edited

Loading

Lms24 left a comment •

edited

Loading

codecov bot commented May 28, 2025 •

edited

Loading

Lms24 May 28, 2025 •

edited

Loading

Lms24 left a comment •

edited

Loading