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

Repo name in release management examples #10044

Closed
elramen opened this issue May 15, 2024 · 0 comments · Fixed by #10180
Closed

Repo name in release management examples #10044

elramen opened this issue May 15, 2024 · 0 comments · Fixed by #10180
Labels
Type: Content Issues about the contents of our docs

Comments

@elramen
Copy link
Contributor

elramen commented May 15, 2024

Core or SDK?

Core Sentry product

Which part? Which one?

Releases

Description

In the cli release management docs, it says in a small font “The repository name my-repo should match the name you entered when linking the repo, and should be in the form owner-name/repo-name.”

As this part is easy to miss, it would be great if the code examples would say "repo-owner/repo-name" instead of "my-repo".
With this change, verbosity could also be reduced by removing the text above regarding this, and the user wouldn’t make the mistake of using the wrong format like I did.

Suggested Solution

See above

@elramen elramen added the Type: Content Issues about the contents of our docs label May 15, 2024
elramen added a commit that referenced this issue May 29, 2024
Replace `my-repo` with `repo-owner/repo-name` in the cli examples so that users don't accidentally only use the repo name.

Fixes GH-10044
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Content Issues about the contents of our docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant