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

SDK specific Release docs do not convey that release should be created first

Open rohitkataria-sentryio opened this issue 3 years ago • 0 comments

Core or SDK?

Platform/SDK

Which part? Which one?

All SDKs

Description

If I am under Java docs, I should be at least at some point be educated that its best to first create a release in Sentry (either via sentry-cli) or via the automation options AND also have it as a key in Sentry.init. I only see the latter and not any mention of creating the releases or about informing sentry about releases. I can’t recall if it was always like this.

I want a customer to set up releases and am about to send the docs but if I wear the end user’s hat, the doc flow seems non-ideal. The link I think I should send is: https://docs.sentry.io/platforms/java/configuration/releases/ and the answer seems to lie in “Learn more in our Sentry CLI documentation.” .. I feel its tucked away in the details.

Not to mention that “Additionally, releases are used for applying source maps to minified JavaScript to view original, untransformed source code.” feels totally out of place.

Suggested Solution

Please see Description. In short, we should remove JS specific references in all non-JS SDKs. And we should clarify that a release should first be created. Yes, setting a release in the init, would eventually create a release but perhaps we want to prescribe that it should first be created.

rohitkataria-sentryio avatar Aug 15 '22 18:08 rohitkataria-sentryio