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

Clarify docs about releases #9067

Open
szokeasaurusrex opened this issue Feb 6, 2024 · 1 comment
Open

Clarify docs about releases #9067

szokeasaurusrex opened this issue Feb 6, 2024 · 1 comment
Assignees

Comments

@szokeasaurusrex
Copy link
Member

Core or SDK?

Platform/SDK

Which part? Which one?

Sentry CLI

Description

I recently received a comment from a user, in which the user stated that they were having difficulty understanding "how releases relate to commits, packages/services, projects, deploys, source maps." I fully agree with the user's comment. I have also struggled to understand how releases, projects, deploys, sourcemaps, packages, services, etc. all relate too each other while investigating this issue and other Sentry CLI issues which deal with these concepts, and it has been difficult to find any answers in the docs. This has slowed down my investigations of such issues, since I have had to read through source code anytime I needed to understand how these concepts are actually related to each other. Clarifying these docs would likely not only benefit customers, but also developers at Sentry to understand how these concepts are supposed to relate to each other.

Suggested Solution

We should take some time to fully understand the relationships between releases, commits, projects, deploys, source maps, etc., and we should clearly document these, perhaps with some sort of diagram.

@szokeasaurusrex
Copy link
Member Author

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)

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

No branches or pull requests

2 participants