Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(nuxt): Add Nuxt wizard instructions #11984

Merged
merged 4 commits into from
Nov 29, 2024
Merged

docs(nuxt): Add Nuxt wizard instructions #11984

merged 4 commits into from
Nov 29, 2024

Conversation

s1gr1d
Copy link
Member

@s1gr1d s1gr1d commented Nov 27, 2024 •
edited
Loading

DESCRIBE YOUR PR

Part of #11978

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.): 28.11.
  • 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

@vercel Vercel
Copy link

vercel bot commented Nov 27, 2024 •
edited
Loading

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 Nov 29, 2024 9:45am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 29, 2024 9:45am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 29, 2024 9:45am

@codecov Codecov
Copy link

codecov bot commented Nov 27, 2024 •
edited
Loading

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.2MB 9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.11MB 6 bytes (-0.0%) ⬇️

@s1gr1d s1gr1d self-assigned this Nov 28, 2024
@s1gr1d s1gr1d marked this pull request as ready for review November 28, 2024 14:35
Lms24
Lms24 approved these changes Nov 28, 2024
View reviewed changes
Copy link
Member

@Lms24 Lms24 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice work! We just need to fix the source maps section and then I think this is ready!

(I accidentally already approved this but I trust your judgement with making the changes. Good to go from my end once the comments are addressed!)

@smeubank
Copy link
Member

we have some manual setup docs, still after the wizard, i would remove them, this is cofnsign to a user setting up for the first time, if they need to setup source maps they should go use that wizard.

verify also tells them how to set up what the wizard hopefully did, it should just be how to run and naviate to the page the wizard attempted to inject

image

andreiborza
andreiborza reviewed Nov 28, 2024
View reviewed changes
platform-includes/getting-started-primer/javascript.nuxt.mdx Outdated
Comment on lines 7 to 37
Sentry's Nuxt SDK enables automatic reporting of errors and performance data.

## Compatibility

The Sentry Nuxt SDK supports Nuxt version `3.7.0` and above. For best results, we recommend
using Nuxt `3.14.0` or later, which includes updated dependencies critical to the SDK's functionality.

In case you are using Nuxt before version `3.14.0`, add the following overrides:

```json {tabTitle:npm} {filename:package.json}
"overrides": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:yarn} {filename:package.json}
"resolutions": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:pnpm} {filename:package.json}
"pnpm": {
"overrides": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
}
```
Copy link
Member

Choose a reason for hiding this comment

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

I'd remove all of this from the getting started page as the wizard takes care of it and I think it's just confusing for users. It's better kept in imanual installation methods.

Copy link
Member Author

Choose a reason for hiding this comment

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

I removed everything after "In case you are using Nuxt before version 3.14.0, add the following overrides:" 👍

I left the general version compatibility notice.

@s1gr1d s1gr1d requested a review from andreiborza November 29, 2024 09:19
@s1gr1d s1gr1d requested a review from coolguyzone November 29, 2024 09:24
@s1gr1d s1gr1d merged commit c20b570 into master Nov 29, 2024
11 checks passed
@s1gr1d s1gr1d deleted the sig/nuxt-wizard branch November 29, 2024 09:46
@s1gr1d s1gr1d mentioned this pull request Nov 27, 2024
Closed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@smeubank smeubank smeubank left review comments

@Lms24 Lms24 Lms24 approved these changes

@mydea mydea Awaiting requested review from mydea

@andreiborza andreiborza Awaiting requested review from andreiborza

@coolguyzone coolguyzone Awaiting requested review from coolguyzone

Assignees

@s1gr1d s1gr1d

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@s1gr1d @smeubank @Lms24 @andreiborza