Skip to content

Commit 6c19ba9

Browse files
lforstlobsterkatie
andauthored
Apply suggestions from code review
Co-authored-by: Katie Byers <[email protected]>
1 parent 6632dfc commit 6c19ba9

File tree

13 files changed

+33
-33
lines changed

13 files changed

+33
-33
lines changed

src/platform-includes/sourcemaps/overview/javascript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We've compiled a list of guides on how to upload source maps to Sentry for the m
1212

1313
### Other Tools
1414

15-
If you're not using one of these tools, we assume you already know how to generate source maps for your toolchain and we recommend you upload them using the <PlatformLink to="/sourcemaps/uploading/cli/">Sentry CLI</PlatformLink>.
15+
If you're not using one of these tools, we assume you already know how to generate source maps with your toolchain and we recommend you upload them using <PlatformLink to="/sourcemaps/uploading/cli/">Sentry CLI</PlatformLink>.
1616

1717
<PlatformSection notSupported={["node"]}>
1818

src/platform-includes/sourcemaps/overview/javascript.remix.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Upload Source Maps for a Svelte Project
1+
## Upload Source Maps for a Remix Project
22

33
Sentry uses [releases](/product/releases/) to match the correct source maps to your events.
44
This page is a guide on how to create releases and upload source maps to Sentry when bundling your Remix app.
@@ -11,10 +11,10 @@ Please refer to the [Remix CLI docs](https://remix.run/docs/en/v1/other-api/dev#
1111

1212
### 2. Create a Release and Upload Source Maps
1313

14-
The Sentry Remix SDK provides an automatic script to create a release and upload source maps after you built your project.
14+
The Sentry Remix SDK provides a script to automatically create a release and upload source maps after you've built your project.
1515
Under the hood, it uses the Sentry CLI.
1616

17-
This script requires some configuration that can either be done through a `.sentryclirc` file in the root of your project or through environment variables:
17+
This script requires some configuration, which can either be done through a `.sentryclirc` file in the root of your project or through environment variables:
1818

1919
<Note>
2020

@@ -61,7 +61,7 @@ For more advanced configuration, [use `sentry-cli` directly to upload source map
6161

6262
### 3. Remove Remix Source Maps
6363

64-
Remix validly discourages the user to have source maps in production. After uploading the maps to Sentry we suggest you delete the `.map` files, here's a simple example in bash:
64+
Remix validly discourages the user from hosting source maps in production. After uploading the maps to Sentry, we suggest you delete the `.map` files. Here's a simple example in bash:
6565

6666
```bash
6767
rm ./public/**/*.map

src/platform-includes/sourcemaps/overview/javascript.svelte.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export default defineConfig({
5353
include: "./dist",
5454

5555
// Auth tokens can be obtained from https://sentry.io/settings/account/api/auth-tokens/
56-
// and needs the `project:releases` and `org:read` scopes
56+
// and need `project:releases` and `org:read` scopes
5757
authToken: process.env.SENTRY_AUTH_TOKEN,
5858

5959
// Optionally uncomment the line below to override automatic release name detection
@@ -65,7 +65,7 @@ export default defineConfig({
6565

6666
### Other Bundlers
6767

68-
If you're using bundlers other than Vite, check out our general guide on how to <PlatformLink to="/sourcemaps/uploading/">upload source maps</PlatformLink> with them, or refer to their documentation.
68+
If you're using a bundler other than Vite, check out our general guide on how to <PlatformLink to="/sourcemaps/uploading/">upload source maps</PlatformLink>, or refer to your bundler's documentation.
6969

7070
<Note>
7171

src/platform-includes/sourcemaps/primer/javascript.nextjs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
To show readable stack traces in your Sentry errors, once configured, the `@sentry/nextjs` SDK will generate and upload source maps automatically.
1+
`@sentry/nextjs` will generate and upload source maps automatically, in order to enable errors to have readable stacktraces.
22

33
To upload source maps, the `@sentry/nextjs` SDK uses the [Sentry Webpack Plugin](https://github.com/getsentry/sentry-webpack-plugin) under the hood. See the [Manual Configuration](../manual-setup/) page and the Sentry [Webpack Plugin documentation](https://github.com/getsentry/sentry-webpack-plugin#cli-configuration) for more details.
44

src/platform-includes/sourcemaps/upload/cli/javascript.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
When choosing [`sentry-cli`](/product/cli/) as the method to upload your source files, we assume you already know how to generate source maps within your build tool chain.
1+
If you choose [`sentry-cli`](/product/cli/) as the method to upload your source files, we assume you already know how to generate source maps within your build tool chain.
22

33
Sentry uses [releases](/product/releases/) to match the correct uploaded source maps to your events. You can use `sentry-cli` to create releases and upload source maps to Sentry.
44

@@ -9,7 +9,7 @@ To be able to match Sentry errors with the correct release, you must provide a `
99
```javascript
1010
Sentry.init({
1111
// Make sure this value is identical to the name you give the release that you
12-
// will create below using Sentry CLI
12+
// create below using Sentry CLI
1313
release: "<release_name>",
1414
});
1515
```
@@ -65,7 +65,7 @@ You can verify your uploaded artifacts by navigating to **[Project] > Project Se
6565

6666
</Note>
6767

68-
Until now, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded and your app has been published successfully, finalize the release with the following command:
68+
At this point, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded and your app has been published successfully, finalize the release with the following command:
6969

7070
```bash
7171
sentry-cli releases finalize <release_name>

src/platform-includes/sourcemaps/upload/esbuild/javascript.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ yarn add @sentry/esbuild-plugin --dev
1212

1313
## Configure
1414

15-
Learn more about the configuration of the plugin using our [Sentry esbuild Plugin documentation](https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/esbuild-plugin).
15+
Learn more about configuring the plugin in our [Sentry esbuild Plugin documentation](https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/esbuild-plugin).
1616

1717
Example:
1818

@@ -34,7 +34,7 @@ require("esbuild").build({
3434
include: "./dist",
3535

3636
// Auth tokens can be obtained from https://sentry.io/settings/account/api/auth-tokens/
37-
// and needs the `project:releases` and `org:read` scopes
37+
// and need `project:releases` and `org:read` scopes
3838
authToken: process.env.SENTRY_AUTH_TOKEN,
3939

4040
// Optionally uncomment the line below to override automatic release name detection

src/platform-includes/sourcemaps/upload/primer/javascript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
We provide guides on how to upload source maps to Sentry for the most popular JavaScript build tools.
1+
We provide guides on uploading source maps to Sentry for the most popular JavaScript build tools.
22
Pick one from the list below to learn more.
33

44
<PlatformSection notSupported={["node"]}>

src/platform-includes/sourcemaps/upload/rollup/javascript.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ yarn add @sentry/rollup-plugin --dev
1313

1414
## Configuration
1515

16-
Learn more about the configuration of the plugin using our [Sentry Rollup Plugin documentation](https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/rollup-plugin).
16+
Learn more about configuring the plugin in our [Sentry Rollup Plugin documentation](https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/rollup-plugin).
1717

1818
Example:
1919

@@ -32,7 +32,7 @@ export default {
3232
include: "./out",
3333

3434
// Auth tokens can be obtained from https://sentry.io/settings/account/api/auth-tokens/
35-
// and needs the `project:releases` and `org:read` scopes
35+
// and need `project:releases` and `org:read` scopes
3636
authToken: process.env.SENTRY_AUTH_TOKEN,
3737

3838
// Optionally uncomment the line below to override automatic release name detection

src/platform-includes/sourcemaps/upload/systemjs/javascript.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Sentry uses [releases](/product/releases/) to match the correct source maps to your events.
2-
If you're using SystemJS to bundle your project, your should configure SystemJS to generate source maps and use Sentry CLI to create the release and upload source maps.
2+
If you're using SystemJS to bundle your project, your should configure SystemJS to generate source maps and use Sentry CLI to create the release and upload the source maps.
33

44
## 1. Update SDK Options
55

@@ -8,7 +8,7 @@ To be able to match Sentry errors with the correct release, you must provide a `
88
```javascript
99
Sentry.init({
1010
// Make sure this value is identical to the name you give the release that you
11-
// will create below using Sentry CLI
11+
// create below using Sentry CLI
1212
release: "<release_name>",
1313
});
1414
```
@@ -35,7 +35,7 @@ This example configuration will inline your original, un-transformed source code
3535

3636
<Note>
3737

38-
You can find instructions on how to install Sentry CLI here: https://docs.sentry.io/product/cli/installation/
38+
You can find installation instructions for Sentry CLI here: https://docs.sentry.io/product/cli/installation/
3939

4040
For more info on Sentry CLI configuration visit the [Sentry CLI configuration docs](/product/cli/configuration/).
4141

@@ -78,11 +78,11 @@ sentry-cli releases files <release_name> upload-sourcemaps /path/to/files
7878

7979
<Note>
8080

81-
You can verify your uploaded artifacts by navigating to **[Project] > Project Settings (gear icon in top right corner) > Source Maps** on Sentry.
81+
You can verify that your upload was successful by navigating to **[Project] > Project Settings (gear icon in top right corner) > Source Maps** on Sentry.
8282

8383
</Note>
8484

85-
Until now, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded, and your app has been published successfully, finalize the release with the following command:
85+
At this point, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded, and your app has been published successfully, finalize the release with the following command:
8686

8787
```bash
8888
sentry-cli releases finalize <release_name>

src/platform-includes/sourcemaps/upload/typescript/javascript.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Note>
22

3-
This guide is only applicable if you're using `tsc` to compile your project. If you use another tool (such as, Webpack) in combination with TypeScript, you'll most likely want to follow that guide instead.
3+
This guide is only applicable if you're using `tsc` to compile your project. If you use another tool (such as Webpack) in combination with TypeScript, you'll most likely want to follow that guide instead.
44

55
</Note>
66

@@ -17,7 +17,7 @@ First, configure the TypeScript compiler to output source maps:
1717
"sourceMap": true,
1818
"inlineSources": true,
1919

20-
// Configure the `sourceRoot`` property as / to strip the build path prefix from
20+
// Set `sourceRoot` to `/` to strip the build path prefix from
2121
// generated source code references. This allows Sentry to match source files
2222
// relative to your source root folder.
2323
"sourceRoot": "/"
@@ -32,7 +32,7 @@ To be able to match Sentry errors with the correct release, you must provide a `
3232
```javascript
3333
Sentry.init({
3434
// Make sure this value is identical to the name you give the release that you
35-
// will create below using Sentry CLI
35+
// create below using Sentry CLI
3636
release: "<release_name>",
3737
});
3838
```
@@ -41,7 +41,7 @@ Sentry.init({
4141

4242
<Note>
4343

44-
You can find instructions on how to install Sentry CLI here: https://docs.sentry.io/product/cli/installation/
44+
You can find installation instructions for Sentry CLI here: https://docs.sentry.io/product/cli/installation/
4545

4646
For more info on Sentry CLI configuration visit the [Sentry CLI configuration docs](/product/cli/configuration/).
4747

@@ -84,11 +84,11 @@ sentry-cli releases files <release_name> upload-sourcemaps /path/to/files
8484

8585
<Note>
8686

87-
You can verify your uploaded artifacts by navigating to **[Project] > Project Settings (gear icon in top right corner) > Source Maps** on Sentry.
87+
You can verify that your upload was successful by navigating to **[Project] > Project Settings (gear icon in top right corner) > Source Maps** on Sentry.
8888

8989
</Note>
9090

91-
Until now, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded and your app has been published successfully, finalize the release with the following command:
91+
At this point, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded and your app has been published successfully, finalize the release with the following command:
9292

9393
```bash
9494
sentry-cli releases finalize <release_name>

src/platform-includes/sourcemaps/upload/uglifyjs/javascript.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Sentry uses [releases](/product/releases/) to match the correct source maps to your events.
2-
If you're using UglifyJS to transpile your project you should configure UglifyJS to generate source maps and use Sentry CLI to create the release and upload source maps.
2+
If you're using UglifyJS to transpile your project you should configure UglifyJS to generate source maps and use Sentry CLI to create the release and upload the source maps.
33

44
## 1. Update SDK Options
55

@@ -8,7 +8,7 @@ To be able to match Sentry errors with the correct release, you must provide a `
88
```javascript
99
Sentry.init({
1010
// Make sure this value is identical to the name you give the release that you
11-
// will create below using Sentry CLI
11+
// create below using Sentry CLI
1212
release: "<release_name>",
1313
});
1414
```
@@ -27,7 +27,7 @@ uglifyjs app.js \
2727

2828
<Note>
2929

30-
You can find instructions on how to install Sentry CLI here: https://docs.sentry.io/product/cli/installation/
30+
You can find installation instructions for Sentry CLI here: https://docs.sentry.io/product/cli/installation/
3131

3232
For more info on Sentry CLI configuration visit the [Sentry CLI configuration docs](/product/cli/configuration/).
3333

@@ -74,7 +74,7 @@ You can verify your uploaded artifacts by navigating to **[Project] > Project Se
7474

7575
</Note>
7676

77-
Until now, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded, and your app has been published successfully, finalize the release with the following command:
77+
At this point, the release is in a draft state (“_unreleased_”). Once all source maps have been uploaded, and your app has been published successfully, finalize the release with the following command:
7878

7979
```bash
8080
sentry-cli releases finalize <release_name>

src/platform-includes/sourcemaps/upload/vite/javascript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ yarn add @sentry/vite-plugin --dev
1212

1313
## Configuration
1414

15-
Learn more about the configuration of the plugin using our [Sentry Vite Plugin documentation](https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/vite-plugin).
15+
Learn more about configuring the plugin in our [Sentry Vite Plugin documentation](https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/vite-plugin).
1616

1717
Example:
1818

src/platform-includes/sourcemaps/upload/webpack/javascript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ yarn add --dev @sentry/webpack-plugin
1313

1414
## Configuration
1515

16-
Learn more about the configuration of the plugin using our [Sentry Webpack Plugin documentation](https://github.com/getsentry/sentry-webpack-plugin).
16+
Learn more about configuring the plugin in our [Sentry Webpack Plugin documentation](https://github.com/getsentry/sentry-webpack-plugin).
1717

1818
Example:
1919

0 commit comments

Comments
 (0)