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

Re-organize Next.js Manual Setup page #12487

Open
inventarSarah opened this issue Jan 28, 2025 · 1 comment
Open

Re-organize Next.js Manual Setup page #12487

inventarSarah opened this issue Jan 28, 2025 · 1 comment

Comments

@inventarSarah
Copy link
Collaborator

SDK

JavaScript SDK

Description

We want to rework the Manual Setup page into the Next.js quick start guide (manual setup).
And ideally, the wizard and manual quick start guides lead to the same results.

However, currently, the manual setup page contains a lot of advanced topics that are not part of the quick start -> we want to move this content to other, more suitable pages

Suggested Solution

identify the information we want to move away from the Manual Setup page and find new homes for them (add to existing pages or create new ones)

consider: does it make sense to create pages under a "Next.js Features" page (see React) and have the next.js-specific information there

@inventarSarah
Copy link
Collaborator Author

I looked at the “Manual Setup” page to identify the content that is different from the wizard installer. At each point I suggested a possible new location for the content.

Extend Configuration

Extend Sentry Webpack Plugin Options

  • could not find this anywhere else in the documentation
  • can we remove this from the next.js documentation and instead provide it eg with the Webpack plugin documenation?

Create initialization config files

second paragraph below code sample:

"To set up this file, enable the Next.js instrumentation hook by setting the experimental.instrumentationHook to true in your next.config.js."

Report react component render errors

React Render Errors in App Router

Paragraph below first code sample:

"Note that if you create Next.js error.js files, these files will take precedence ..." + Code example

Errors from Nested React Server Components

content after first code example

"If you need additional logic..."

  • not in wizard
  • possible place:
    • Next.js Features
      • Capture errors from nested react server components

React Render Errors in Pages Router

  • not in wizard
  • possible place
    • Next.js Features
      • Custom error page

Instrument Next.js Server Actions

not in wizard

  • possible place
    • Next.js Features
      • Instrument server actions

Configure Source maps

Disable Source Maps

Use hidden-source-map

Widen the Upload Scope

  • this is in the wizard -> but let's shorten this and move the original content to a new place so the info is still accessible
  • possible place:

Configure Tunneling to avoid Ad-Blockers

  • this is in the wizard -> but let's shorten this and move the original content to a new place so the info is still accessible
  • there is no dedicated space (?)
    • in options we link to Troubleshooting to learn more about this but we should not use the troubleshooting section for documentation and need to provide the information somewhere else
    • possible place:
      • create a new page for "Tunneling" (eg under Configuration)
        • depends on how important this topic is -> if this is critical it should be on nav level 1

Configure Server-side Auto-instrumentation

Disable API route, middleware and data fetching auto-instrumentation entirely

Opt in to auto-instrumentation on specific routes

Opt out of auto-instrumentation on specific routes

Opt out of auto-instrumentation on middleware

Opt Out of Sentry SDK bundling in Client- or Server-Side

  • not in wizard
  • possible place:
    • Next.js Features
      • Server-side auto-instrumentation

Instrumentation of Vercel Cron Jobs

  • this is in the wizard
  • not sure what to do with that one
    • any ideas?

reactComponentAnnotation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant