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.

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

docs(nuxt): Add manual setup and troubleshooting #11981

Merged
merged 2 commits into from
Nov 28, 2024
Merged

Conversation

s1gr1d
Copy link
Member

@s1gr1d s1gr1d commented Nov 27, 2024

DESCRIBE YOUR PR

Adding the manual setup as an extra page (right now, it is the index page - which will be the setup soon).

I also added the troubleshooting items to the troubleshooting page to make it easier to read. As there was already a similar item regarding pnpm (PR here), I excluded this for Nuxt and added one specifically for Nuxt.

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

Copy link

vercel bot commented Nov 27, 2024

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

Copy link

codecov bot commented Nov 27, 2024

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.13MB 198 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.02MB 6 bytes (-0.0%) ⬇️


### Server-side Setup

1. Add a `sentry.server.config.ts` file to the root of your project:
Copy link
Member

Choose a reason for hiding this comment

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

l: either we use numbering more often than once or we omit it

Suggested change
1. Add a `sentry.server.config.ts` file to the root of your project:
Add a `sentry.server.config.ts` file to the root of your project:

Comment on lines +98 to +100
<Alert level="warning">
In the beta state of the Nuxt SDK, some features may not work with certain deployment providers. Check the progress on GitHub: [Compatibility with different Deployment Platforms](https://github.com/getsentry/sentry-javascript/issues/14029)
</Alert>
Copy link
Member

Choose a reason for hiding this comment

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

Are we planning on making another docs pass before we go stable? If so, all good! Otherwise, let's remove the "beta" wording. Linking to the issue is fine, though we also might add a Compatibility section to the getting started page when we rework it to reference the wizard.

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 would still leave this in for now. Will add the compatibility section 👍

@s1gr1d s1gr1d merged commit 1f72538 into master Nov 28, 2024
11 checks passed
@s1gr1d s1gr1d deleted the sig/nuxt-manual-setup branch November 28, 2024 12:52
@s1gr1d s1gr1d mentioned this pull request Nov 27, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 14, 2024
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.

2 participants