sentry-cli icon indicating copy to clipboard operation
sentry-cli copied to clipboard

ref(docs): Improve `@sentry/cli` installation docs and error message

Open lobsterkatie opened this issue 3 years ago • 2 comments

MOVING TO DRAFT UNTIL PROBLEMS DETAILED IN https://github.com/getsentry/sentry-cli/issues/1348#issuecomment-1268931182 ARE SOLVED


This makes the following changes regarding @sentry/cli installation:

  • Update the error message when downloading fails to mention the SENTRYCLI_USE_LOCAL option and link to README.
  • Create separate @sentry/cli section in README.
  • Add SENTRYCLI_USE_LOCAL option to new section.
  • Add instructions for using a custom CDN, and a helper script for custom CDN setup.

lobsterkatie avatar Oct 05 '22 20:10 lobsterkatie

Fails
:no_entry_sign: Please consider adding a changelog entry for the next release.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Improve `@sentry/cli` installation docs and error message ([#1350](https://github.com/getsentry/sentry-cli/pull/1350))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by :no_entry_sign: dangerJS against 5d98578d691705258aad7304b031b3cb613c779b

github-actions[bot] avatar Oct 05 '22 20:10 github-actions[bot]

@lobsterkatie Looks like this PR has been open for awhile. Are the changes still relevant, and if yes, is the PR ready to be reviewed?

szokeasaurusrex avatar Jan 31 '24 10:01 szokeasaurusrex