Skip to content

Commit 396c03e

Browse files
docs(sourcemaps): Remove mentions of sentry-cli sourcemaps explain (#15481)
## DESCRIBE YOUR PR `sentry-cli sourcemaps explain` has been deprecated for some time, and is scheduled for removal (getsentry/sentry-cli#2865, [CLI-195](https://linear.app/getsentry/issue/CLI-195/remove-sentry-cli-sourcemaps-explain-command)). So, we should remove all mentions of the command from the docs, and point users to alternative debugging steps, instead. Resolves #15471 Resolves [DOCS-2346](https://linear.app/getsentry/issue/DOCS-2346/remove-mentions-of-sentry-cli-sourcemaps-explain-from-the-docs) ## 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 - [x] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [x] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs)
1 parent 18e731b commit 396c03e

File tree

3 files changed

+3
-63
lines changed

3 files changed

+3
-63
lines changed

platform-includes/sourcemaps/legacy-troubleshooting/javascript.mdx

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,4 @@
1-
Setting up source maps can be tricky, but it's worth it to get it right. To troubleshoot your source maps set up, you can either:
2-
3-
1. Use our automated verification tool inside `sentry-cli`, or
4-
2. Follow the manual steps listed below
5-
6-
## Use the Sentry CLI
7-
8-
To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io).
9-
10-
For example, "Event ID: c2ad049f":
11-
12-
![Image highlighting where to find the ID of an event on Sentry](./img/event_id.png)
13-
14-
```shell
15-
sentry-cli sourcemaps explain c2ad049fd9e448ada7849df94575e019
16-
```
17-
18-
The CLI output should give you useful information about what went wrong with your source maps setup.
1+
Setting up source maps can be tricky, but it's worth it to get it right. You can follow the steps below to troubleshoot your source maps set up.
192

203
<PlatformSection notSupported={["javascript.electron"]}>
214

platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -267,31 +267,6 @@ Sentry.init({
267267

268268
If you followed all of the steps above but still have issues setting up source maps using the legacy method this section will try to help troubleshoot your setup.
269269

270-
To troubleshoot your source maps set up, you can either:
271-
272-
1. Use our automated verification tool inside `sentry-cli`, or
273-
2. Follow the manual steps listed below
274-
275-
### Use the Sentry CLI
276-
277-
To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io).
278-
279-
<Alert title="Note" level="warning">
280-
281-
The `sourcemaps explain` command requires an auth token with the following scopes: `project:admin`, `release:admin`, `event:read`, and `organization:read`. We recommend creating an [internal integration token](/organization/integrations/integration-platform/internal-integration/) over a personal token.
282-
283-
</Alert>
284-
285-
For example, "Event ID: c2ad049f":
286-
287-
![Image highlighting where to find the ID of an event on Sentry](./img/event_id.png)
288-
289-
```shell
290-
sentry-cli sourcemaps explain c2ad049fd9e448ada7849df94575e019
291-
```
292-
293-
The CLI output should give you useful information about what went wrong with your source maps setup.
294-
295270
<PlatformSection notSupported={["javascript.electron"]}>
296271

297272
### Verify a release is configured in your SDK

platform-includes/sourcemaps/troubleshooting/javascript.mdx

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,9 @@ Dependency versions that require the legacy method of uploading source maps incl
3030

3131
</Alert>
3232

33-
Setting up source maps can be tricky, but it's worth it to get it right. To troubleshoot your source maps set up, you can either:
33+
Setting up source maps can be tricky, but it's worth it to get it right. You can follow the steps below to troubleshoot your source maps set up.
3434

35-
1. Use our automated verification tool inside `sentry-cli`, or
36-
2. Follow the manual steps listed below
37-
38-
## Use the CLI
39-
40-
To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io).
41-
42-
For example, "Event ID: c2ad049f":
43-
44-
![Image highlighting where to find the ID of an event on Sentry](./img/event_id.png)
45-
46-
```shell
47-
sentry-cli sourcemaps explain c2ad049fd9e448ada7849df94575e019
48-
```
49-
50-
The CLI output should give you useful information about what went wrong with your source maps setup.
51-
If it doesn't, let us know by filing an issue on our [Sentry CLI repo](https://github.com/getsentry/sentry-cli) so we can make it better.
52-
53-
## Follow Manual Steps
35+
## Troubleshooting Steps
5436

5537
### Verify Artifacts Are Uploaded
5638

0 commit comments

Comments
 (0)