Skip to content

Conversation

@inventarSarah
Copy link
Collaborator

@inventarSarah inventarSarah commented Mar 20, 2025

DESCRIBE YOUR PR

Rework the Node.js Getting Started page into a Quick Start guide.

I also created some includes for reusable content and updated existing guides to use these includes -> let me know if you'd prefer we do this in a separate PR!

Note: I've only changed content that is relevant for Issues/Error Monitoring. We'll rework Tracing & Session Replay in a future PR.

Belongs to: #12991

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

@codecov
Copy link

codecov bot commented Mar 20, 2025

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.61MB 762 bytes (0.01%) ⬆️
sentry-docs-client-array-push 9.45MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

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.67kB -0.0%
static/chunks/8931-*.js -3 bytes 397.42kB -0.0%
static/SEk6cjKKk1EREs1rC5k-*.js (New) 578 bytes 578 bytes 100.0% 🚀
static/SEk6cjKKk1EREs1rC5k-*.js (New) 77 bytes 77 bytes 100.0% 🚀
static/JfX0Cd3mXiwm6UMTsnV6L/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/JfX0Cd3mXiwm6UMTsnV6L/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.58MB -0.0%
../instrumentation.js -3 bytes 911.63kB -0.0%
9523.js -3 bytes 887.68kB -0.0%
../app/[[...path]]/page.js.nft.json 257 bytes 383.91kB 0.07%
../app/platform-redirect/page.js.nft.json 257 bytes 383.83kB 0.07%
../app/sitemap.xml/route.js.nft.json 257 bytes 381.8kB 0.07%

Sentry should be initialized as early as possible in your application. We recommend putting the Sentry initialization code into its own file and including that file as the first import in your application entry point as shown in the example below:
### Initialize the Sentry SDK

To import and initialize Sentry, create a file, for example, `instrument.js`, in your project and add the following code:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To import and initialize Sentry, create a file, for example, `instrument.js`, in your project and add the following code:
To import and initialize Sentry, create a file in your project's root directory, for example, `instrument.js`, in your project and add the following code:

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

This is looking great!

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

Nice change! But we need to resolve the TOC issue before as that is rather confusing in the current state

</Alert>

<OnboardingOption optionId="performance">
## Step 4: Set Up React Router
Copy link
Member

Choose a reason for hiding this comment

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

this one is optional

@chargome chargome marked this pull request as draft March 25, 2025 11:17
@chargome chargome changed the title React Quick Start guide for Error Monitoring feature only docs(js): React Quick Start guide for Error Monitoring feature only Mar 25, 2025
@inventarSarah
Copy link
Collaborator Author

@mydea Now that the ToC is resolved, we can move on with this one -- Alex and Charly have already reviewed it.
Let me know if you want to take a look as well; otherwise I'll merge it :)
Thanks!

Copy link
Member

@mydea mydea left a comment

Choose a reason for hiding this comment

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

left one tiny suggestion, other than this looks great!

Co-authored-by: Francesco Gringl-Novy <[email protected]>
@inventarSarah inventarSarah merged commit 7c6ba74 into master Apr 3, 2025
11 checks passed
@inventarSarah inventarSarah deleted the smi/quick-start/react-manual branch April 3, 2025 13:05
@github-actions github-actions bot locked and limited conversation to collaborators Apr 19, 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.

5 participants