Skip to content

Conversation

@inventarSarah
Copy link
Collaborator

@inventarSarah inventarSarah commented Apr 8, 2025

DESCRIBE YOUR PR

  • Rework the Nuxt Getting Started guide into a Quick Start guide.
  • Create and use new platform-includes for reusable content

Closes: #13188 #13187

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

@vercel
Copy link

vercel bot commented Apr 8, 2025

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 Apr 9, 2025 11:14am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Apr 9, 2025 11:14am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Apr 9, 2025 11:14am

problem.

</Expandable>
<PlatformContent includePath="getting-started-features-expandable" />
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created a new platform-include for this content and updated existing quick start guides to use it

2. Click the "Throw Sample Error" button, which triggers an error and starts a performance trace on the client side.

## Verify
To test the server side as well, refer to the "Verify" section in the [Manual setup guide](/platforms/javascript/guides/nuxt/manual-setup/).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a potential future update:
Could we update the wizard to create an example that lets users test client and server side?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s1gr1d can you help answer ⬆ this question?
I was wondering why the wizard only creates the component and not a route like the Next.js wizard?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the example page that is created in the Nuxt wizard, there is also a call to an API route which is created by the wizard as well. But all of this is only created when the wizard detects the app.vue file. Without this, we cannot be sure whether the user is using the Nuxt routing mechanism. With only one page, the Nuxt project would not be using the Nuxt router and the wizard should not change the routing mechanism.

But I think it should be fine to create the component and the API route 🤔 So the component could call the API

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @s1gr1d!
I created an issue in the wizard repo getsentry/sentry-wizard#940

I'll leave this as is for now 👍

@inventarSarah inventarSarah marked this pull request as ready for review April 8, 2025 10:12
@mydea mydea requested a review from s1gr1d April 8, 2025 14:09
throw new Error("Sentry Example API Route Error");
});
```
1. Open the example page `/sentry-example-page` in your browser. For most Nuxt applications, this will be at localhost.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we write the full path here? Since it's always on localhost 🤔

Suggested change
1. Open the example page `/sentry-example-page` in your browser. For most Nuxt applications, this will be at localhost.
1. Open the example page `/sentry-example-page` in your browser. For most Nuxt applications, this will be at localhost:3000/sentry-example-page.

@codecov
Copy link

codecov bot commented Apr 9, 2025

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.13MB 1.0kB (0.01%) ⬆️
sentry-docs-client-array-push 9.47MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

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 338 bytes 384.95kB 0.09%
../app/platform-redirect/page.js.nft.json 338 bytes 384.87kB 0.09%
../app/sitemap.xml/route.js.nft.json 338 bytes 382.84kB 0.09%
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%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/3v9iWUjLT2l8gyGjALqg0/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/3v9iWUjLT2l8gyGjALqg0/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/t1kx_FVcfw2_KZ5IZdgHJ/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/t1kx_FVcfw2_KZ5IZdgHJ/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

@inventarSarah inventarSarah merged commit cd10012 into master Apr 10, 2025
11 checks passed
@inventarSarah inventarSarah deleted the smi/quick-start/nuxt-wizard branch April 10, 2025 07:26
bitsandfoxes pushed a commit that referenced this pull request Apr 24, 2025
* create Nuxt Quick Start guide for wizard setup; create and use new platform-includes

* Apply suggestions from code review

Co-authored-by: Sigrid Huemer <[email protected]>

---------

Co-authored-by: Sigrid Huemer <[email protected]>
@github-actions github-actions bot locked and limited conversation to collaborators Apr 26, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants