getsentry
Document what a "Deploy" is
Core or SDK?
Core Product
Which part? Which one?
Releases and Deploys
Description
Our documentation is missing a description of what a "deploy" is, and how a deploy relates to a release. This confuses our users, and it has also confused me.
Suggested Solution
Clearly document what a deploy is, why someone would want to use it, and how deploys relate to releases. After adding this documentation, it might be helpful to update the Sentry CLI docs for making a deploy to link to the new description of what a deploy is.
Some notes:
- Looks like our Python docs already are describing what Releases are, perhaps this could be moved somewhere else to make it clear that this description generally applies to all platforms, not just Python projects.
- I cannot find any docs page that explains what a Deploy is, at a high level
Clarifying Releases and Deploys should be enough to close this issue (this was the main confusion prompting this issue to be opened). Perhaps, we explain how both of these relate to the other concepts listed in the original description (e.g. a project can have multiple releases, a release is associated with one project)
This issue is very vague. It could mean "just add an explanation of what a release to sentry-cli docs" or rewrite/create pages that document releases, commits, projects, deploys, source maps.
In its current this issue is not actionable. Please update this issue so it is clear what exact problem should be used where in the docs.
![getsantry[bot] avatar](https://avatars.githubusercontent.com/in/66573?v=4 "Published by a pub.dev verified publisher"){kind=small}