[Java] SDK setup for uploading Source Context

smeubank commented 1 year ago

Core or SDK?

Platform/SDK

Which part? Which one?

Java (including Kotlin and Android)

Description

The Java (and related platforms) documentation for configuring an application to create releases and upload source context, includes a lot of variation and is rather verbose. It may not be simple for users to navigate and find the specific configurations which are needed for their application, while being confused with all the different variations of Java and build tools in one page #

Suggested Solution

Is source context industry standard terminology in Java? Can we just say source code or something?

To start we would like to make the structure of the Java documentation for source context follow the same format as JavaScripts source map's docs

Simple before and after picture and statement of why the user should do the following steps
the docs should be easily navigable
with minimum information to get the user to the correct portion of the docs they need without needing to decide in one page which blocks of texts and snippets are and are not relevant to each other
- meaning build tools and versions are clearly separated
the docs should avoid exposing how the sausage is made at sentry (debugIds, release artifacts, and other Sentry specifics)

A random UUID must be generated and placed into the sentry-debug-meta.properties. Such information may be interesting to some users but should not be required reading to get into setting up in the first place

There is a dedicated page for Gradle, but it is not clear to me why that is there and not maven, it also seems to contain content about source context which is duplicated. Instead under source context we could have single dedicated pages for Maven and Gradle

There are product docs (CLI -> Debug Information Files) which include information about uploading source context for Java, this belongs in platform documentation. So as to not duplicate and confuse users reading generic product docs to see things about any specific platform in detail