-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Fixed the broken links that fell through the cracks while the linter⦠#15316
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| ### My Lambda function uses `import` | ||
|
|
||
| If you're using `import` syntax in your function and you're _not_ transpiling the code to CommonJS, follow the [ESM instructions](./install/esm-npm__v9.x). | ||
| If you're using `import` syntax in your function and you're _not_ transpiling the code to CommonJS, follow the [ESM instructions](./npm). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: The "ESM instructions" link in index__v9.x.mdx incorrectly points to npm.mdx instead of the ESM-specific guide.
Severity: HIGH | Confidence: 0.98
π Detailed Analysis
When users click the "ESM instructions" link in index__v9.x.mdx, they are directed to npm.mdx instead of esm-npm__v9.x.mdx. This occurs because the link was changed from [ESM instructions](./install/esm-npm__v9.x) to [ESM instructions](./npm). The npm.mdx guide primarily focuses on CommonJS setup, which can lead ESM users to follow incorrect instructions for their module system. A similar issue exists in layer__v8.x.mdx.
π‘ Suggested Fix
Change the link [ESM instructions](./npm) in index__v9.x.mdx to [ESM instructions](./esm-npm__v9.x) to correctly direct users to the ESM-specific guide.
π€ Prompt for AI Agent
Fix this bug. In docs/platforms/javascript/guides/aws-lambda/install/index__v9.x.mdx at
line 25: When users click the "ESM instructions" link in `index__v9.x.mdx`, they are
directed to `npm.mdx` instead of `esm-npm__v9.x.mdx`. This occurs because the link was
changed from `[ESM instructions](./install/esm-npm__v9.x)` to `[ESM
instructions](./npm)`. The `npm.mdx` guide primarily focuses on CommonJS setup, which
can lead ESM users to follow incorrect instructions for their module system. A similar
issue exists in `layer__v8.x.mdx`.
Did we get this right? π / π to inform future reviews.
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) β¬οΈ. This is within the configured threshold β Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
β¦#15316) ## DESCRIBE YOUR PR Related to #15312 Fixed broken links that the 404 linter didn't catch while it was broken. ## On Devloper Docs - π http://localhost:3000/sdk/telemetry/profiles/continuous-profiling-api - `[Replay session](/product/explore/session-replay/web/)` - π http://localhost:3000/sdk/telemetry/traces/modules/ai-agents - `[general size limits](/concepts/data-management/size-limits/)` ## On user facing docs - π http://localhost:3000/security-legal-pii/security/data-retention-periods - `[Uptime](/product/monitoring/)` - `[Attachments](/product/issues/issue-details/attachments/)` - π http://localhost:3000/platforms/javascript/guides/aws-lambda/install__v9.x - `[using our Lambda Layer (recommended)](./install/layer__v9.x)` -` [installing the Sentry AWS NPM package](./install/cjs-npm__v9.x)` - `[ESM instructions](./install/esm-npm__v9.x)` - π http://localhost:3000/platforms/javascript/guides/cloudflare/sourcemaps - `[Cloudflare Workers guide](/platforms/javascript/sourcemaps/uploading/wrangler/)` - π http://localhost:3000/platforms/javascript/guides/nuxt/sourcemaps - `[source maps options](/platforms/javascript/guides/nuxt/configuration/build/#source-maps-options)` - π http://localhost:3000/platforms/javascript/guides/solidstart/sourcemaps - `[Manual Configuration](../overview/javascript.solidstart.mdx)` - `[source maps options](/platforms/javascript/guides/solidstart/configuration/build/#source-maps-options)` - π http://localhost:3000/platforms/javascript/guides/aws-lambda/install/layer__v9.x - `[manually](../cjs-npm)` - `[ESM guide](../esm-npm)` - π http://localhost:3000/platforms/javascript/guides/cordova/configuration/options - Obscured CORS docs because it doesn't apply to Cordova - π http://localhost:3000/platforms/javascript/guides/electron/configuration/options - `[Custom IPC Namespace section](/platforms/javascript/guides/electron/platforms/javascript/guides/electron/#custom-ipc-namespace)` - π http://localhost:3000/platforms/javascript/guides/aws-lambda/configuration/lambda-wrapper - `[initializing the SDK in code](../../install/cjs-layer#alternative-initialize-the-sdk-in-code)` - π http://localhost:3000/platforms/javascript/guides/aws-lambda/install/npm__v9.x - `[CommonJS instructions](./cjs-npm__v9.x)` - `[ESM instructions](./esm-npm__v9.x)` - `[CommonJS instructions](./cjs-npm__v9.x)` - `[ESM instructions](./esm-npm__v9.x)` - π http://localhost:3000/platforms/javascript/guides/aws-lambda/install/cjs-npm__v9.x - `[Lambda Layer](../cjs-layer)` - π http://localhost:3000/platforms/javascript/guides/electron/configuration/environments - `[Custom IPC Namespace section](/platforms/javascript/guides/electron/platforms/javascript/guides/electron/#custom-ipc-namespace)` - π http://localhost:3000/platforms/javascript/guides/aws-lambda/configuration/integrations/unhandledrejection - `[manually wrapped](/platforms/javascript/guides/aws-lambda/install/cjs-layer/#alternative-initialize-the-sdk-in-code)` ## 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.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] 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](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <shannonanahata@gmail.com> Co-authored-by: Abdellah Hariti <haritiabdellah@gmail.com>
DESCRIBE YOUR PR
Related to #15312
Fixed broken links that the 404 linter didn't catch while it was broken.
On Devloper Docs
[Replay session](/product/explore/session-replay/web/)[general size limits](/concepts/data-management/size-limits/)On user facing docs
[Uptime](/product/monitoring/)[Attachments](/product/issues/issue-details/attachments/)[using our Lambda Layer (recommended)](./install/layer__v9.x)-
[installing the Sentry AWS NPM package](./install/cjs-npm__v9.x)[ESM instructions](./install/esm-npm__v9.x)[Cloudflare Workers guide](/platforms/javascript/sourcemaps/uploading/wrangler/)[source maps options](/platforms/javascript/guides/nuxt/configuration/build/#source-maps-options)[Manual Configuration](../overview/javascript.solidstart.mdx)[source maps options](/platforms/javascript/guides/solidstart/configuration/build/#source-maps-options)[manually](../cjs-npm)[ESM guide](../esm-npm)[Custom IPC Namespace section](/platforms/javascript/guides/electron/platforms/javascript/guides/electron/#custom-ipc-namespace)[initializing the SDK in code](../../install/cjs-layer#alternative-initialize-the-sdk-in-code)[CommonJS instructions](./cjs-npm__v9.x)[ESM instructions](./esm-npm__v9.x)[CommonJS instructions](./cjs-npm__v9.x)[ESM instructions](./esm-npm__v9.x)[Lambda Layer](../cjs-layer)[Custom IPC Namespace section](/platforms/javascript/guides/electron/platforms/javascript/guides/electron/#custom-ipc-namespace)[manually wrapped](/platforms/javascript/guides/aws-lambda/install/cjs-layer/#alternative-initialize-the-sdk-in-code)IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: