docs(nuxt): Add Nuxt docs for manual setup #10981
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
s1gr1d
requested review from
lizokm,
mydea,
Lms24 and
andreiborza
and removed request for
mydea
Bundle ReportChanges will increase total bundle size by 9.86kB ⬆️
|
There was a problem hiding this comment.
Great docs! I had some wording suggestions but feel free to apply them liberally or go with your own version. General idea: Try to keep things concise and opinionated, especially in the main "Getting Started" page. I think this is already in a good state.
Also (not for this PR but I got reminded) we need to add Nuxt to our platform icons package to get the fancy logo :)
platform-includes/getting-started-sourcemaps/javascript.nuxt.mdx
Outdated
Show resolved
Hide resolved
| <template> | ||
| <button id="errorBtn" @click="triggerError">Trigger Error</button> | ||
| </template> | ||
| ``` |
There was a problem hiding this comment.
l: Theoretically we could also show them how to capture an error on the server side. Not a high-prio task though, feel free to tackle later or ignore :)
| To upload source maps, you need to specify your Sentry auth token as well as your org and project slugs. You can specify those in the `sourceMapsUploadOptions` option | ||
| inside the `sentry` options of your `nuxt.config.ts`. |
There was a problem hiding this comment.
l: l: I'd use "you can" formulations sparingly. Our general "voice"/mentality is that we are opinionated and tell people what they should do to get the SDK set up.
| To upload source maps, you need to specify your Sentry auth token as well as your org and project slugs. You can specify those in the `sourceMapsUploadOptions` option | |
| inside the `sentry` options of your `nuxt.config.ts`. | |
| To upload source maps, specify your Sentry auth token as well as your org and project slugs. Set them in the `sourceMapsUploadOptions` option | |
| inside the `sentry` options of your `nuxt.config.ts`. |
(I'm aware that we're probably having similar wording in countless places but I think we should try to be more concise and straight forward when we have the chance)
(Also if someone from docs teams sees this differently, please feel free to roast me :D)
| 2. Add an import flag to the `NODE_OPTIONS` of your `nuxt preview` in `package.json`, so the file loads before any | ||
| other imports: |
There was a problem hiding this comment.
m: I'd probably word this a bit differently because it's not just about their preview command but also where people actually deploy their app.
Something along the lines of
| 2. Add an import flag to the `NODE_OPTIONS` of your `nuxt preview` in `package.json`, so the file loads before any | |
| other imports: | |
| 2. Add an `--import` flag to the `NODE_OPTIONS` environment variable wherever you run your application. For example, for local previews, adjust your `package.json` script: |
Then, below the code snippet we could add a sentence like
"Make sure to also add this environment variable in your deployment environment, for example on Vercel or Netlify"
# Conflicts: # docs/platforms/javascript/common/tracing/instrumentation/opentelemetry.mdx
DESCRIBE YOUR PR
Adding manual setup docs for Nuxt. There is no wizard script yet, so all manual setup instructions are added to the "getting started" instead of an extra "Manual Setup".
closes getsentry/sentry-javascript#13239
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: