Skip to content
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

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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

lobsterkatie
Copy link
Member

@lobsterkatie lobsterkatie commented Oct 5, 2022

MOVING TO DRAFT UNTIL PROBLEMS DETAILED IN #1348 (comment) 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.

@github-actions
Copy link

github-actions bot commented Oct 5, 2022

Fails
🚫 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 🚫 dangerJS against 5d98578

@szokeasaurusrex
Copy link
Member

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants