Document Java Source Context #7086
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@smeubank @stephanie-anderson preview is now working :-) |
There was a problem hiding this comment.
i'd like to proceed with approving and merging these changes, but I'd like us to consider updating these pages to work like the JS source maps pages today
- meaning a little less text
- similar image to show before and after
- set up sub pages instead of lists of each option for plugin config
Ideally this should make the page easier to consume and things like UUIDs for debug files should be hidden away
I will take a crack at it later if I get time
There was a problem hiding this comment.
It'd be awesome if we can split up the source code context in a product's page (explaining the feature but platform agnostic) so that platforms can just link to when they offer support.
This is tracked here https://www.notion.so/sentry/x-Source-Context-adoption-83a34f599c9745498aa20849ac44fdc8?pvs=4#43bdef3f5b2142e59b180fafae6e3bf8
Then the source code context could add includes (with code snippets) on how to install per platform, this makes the content/feature more discoverable and easy to add support.
There was a problem hiding this comment.
I agree that restructuring would help these docs a lot! I really like the idea of splitting the source code context into a product page.
There was a problem hiding this comment.
LGTM I just want to follow up with a restructuring PR based on how JS is setup, I think it might be a little easier to consume for users looking at different platforms if they are the same structure, and it focuses that users don't need to scroll around content they are not concerned with
And yea some minor points about remocing code comments in snippets
Other wise let's gooooo! :D
There was a problem hiding this comment.
I am wondering if this should live in one place in java docs and from product docs we could link there, or it could be an include that we add instead
again I think this could be in a restructuring PR to not delay this
There was a problem hiding this comment.
yea this is something we need to cleanup when work on improving java onboarding in wizard
There was a problem hiding this comment.
shouldn't the v3 snippets appear first by default? to get most people on latest versions?
There was a problem hiding this comment.
Yeah we did this order back when v3 and our support for it was very new. Can change in a follow up PR.
There was a problem hiding this comment.
same things, latest first? would be nice if the who page could toggle between maven and gradle but that is too complex something to handle in onboarding wizard though for sure
There was a problem hiding this comment.
Yeah this tab thin doesn't work in the wizard. We can figure out maven/gradle and other toggles in getsentry/sentry#50226
Co-authored-by: Markus Hintersteiner <markus.hintersteiner@sentry.io>
|
@shanamatthews could you please give this a review? |
There was a problem hiding this comment.
Sorry for the delay on this review! I went down a bit of a rabbit hole about how this could be restructured to be easier to follow, but I agree with Steven.
Let's publish this version and follow up with a PR to restructure.
I tried to keep my comments to style guide/grammar fixes and left the structure alone for now.
@smeubank and @adinauer - let me know if you want to have a quick meeting to discuss restructuring this!
There was a problem hiding this comment.
I agree that restructuring would help these docs a lot! I really like the idea of splitting the source code context into a product page.
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
|
Thanks everyone. Let's do follow up PR(s) for restructuring. Will merge this once https://github.com/getsentry/sentry-android-gradle-plugin |
Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>
Pre-merge checklist
If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.
Description of changes
Describe your changes here. If your PR relates to or resolves an issue, add a link to that too.
See getsentry/sentry-java#633 for more details.