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

Merge Kotlin and Kotlin multiplaform into one #11848

Closed
bruno-garcia opened this issue Nov 17, 2024 · 7 comments · Fixed by #12302
Closed

Merge Kotlin and Kotlin multiplaform into one #11848

bruno-garcia opened this issue Nov 17, 2024 · 7 comments · Fixed by #12302

Comments

@bruno-garcia
Copy link
Member

bruno-garcia commented Nov 17, 2024

SDK

Kotlin Multiplatform SDK

Description

We have two entries on the docs for Kotlin:
Image

It takes space in the landing page as well as the drop down.

Kotlin docs is only a landing page to route the reader to either Android, Java or Kotlin Multi-platform: https://docs.sentry.io/platforms/kotlin/
Image

It does that while showing sentry-java information the right side.
Image

Kotlin extensions, which lives under the Java docs, apply to Kotlin in general, including KMP.
https://docs.sentry.io/platforms/java/enriching-events/scopes/#kotlin-coroutines

Kotlin itself has one doc: https://kotlinlang.org/
It mentions its capabilities, including KMP.

Suggested Solution

I propose we merge both things into one area: Kotlin
Redirect all kotlin-multiplatform docs to kotlin, and move all pages there.

The landing page can have the same clarification that we have specific Android and Java (JVM) docs, including Spring Boot, elsewhere.

A smaller banner could live on top of all pages that are specific to KMP, with this clarification about Android and JVM docs.

An alternative solution is to include KMP as a sub-platform. Similar to how Apple/iOS is layed out:
Image

We could then have:

  • Kotlin - Same as today, + an include to the same Kotlin Extensions docs we have under Java
  • Kotlin - Multiplatform (contents of KMP docs today)

Some other ideas I'm not very convinced about:

  • Android -> Just a landing page with a note to go to Android?
  • All sub folders from Java?

Perhaps the docs infra could make Kotlin point to Java, but just change the icon/URL otherwise to be Kotlin?

@kahest @HazAT @buenaflor wdyt?

@kahest
Copy link
Member

kahest commented Nov 18, 2024

@bruno-garcia do you think having two items is confusing, or is the main point that it takes too much space? FWIW, KMP has much more traffic (2x that of Kotlin on the landing page), so I kinda like having KMP called out explicitly. No strong opinions against merging, but I wouldn't want to use sub-platforms/guides as we do for Apple, it's a bit annoying to maintain and only really usable if most of the content is the same IMO.

@bruno-garcia
Copy link
Member Author

bruno-garcia commented Nov 24, 2024

Yeah it was mainly odd to have 2 entries for what from the outside seems could be the same entry point.

Regarding the traffic I'd argue it's very likely the same traffic would exist under platforms/kotlin/multiplatform since the content would still exist, just the URL would change. We can redirect the existing URLs to the new path under /kotlin so links are not broken.
The current /kotlin doc not having traffic isn't surprising because it has no content so it'll be mostly people who land on the landing page and click on it to see what's inside. Only to find basically 3 links.

The part that makes it harder to justify changing things is:

I wouldn't want to use sub-platforms/guides as we do for Apple, it's a bit annoying to maintain and only really usable if most of the content is the same IMO.

If there's no easy way to structure things, then I don't know how we would do this.

Maybe @chargome or @coolguyzone have ideas?

@coolguyzone
Copy link
Contributor

coolguyzone commented Nov 25, 2024

Hey @bruno-garcia, I like this idea, I think the number of SDKs we list is a bit overwhelming, anything we can do to consolidate it would be great. It seems reasonable to assume that people looking for Kotlin Multiplatform will click on Kotlin, it might cost them one extra click to get the content they want, but that seems fine to me. @lizokm may have thoughts about this as well.

@lizokm
Copy link
Contributor

lizokm commented Nov 26, 2024

Would love to get @kahest and @buenaflor 's opinion as well :)

@kahest
Copy link
Member

kahest commented Nov 26, 2024

let's do it :)

@buenaflor
Copy link
Contributor

no objections here 👍

@chargome
Copy link
Member

chargome commented Nov 26, 2024

Just want to mention that if you want Kotlin Multiplatform to appear in dropdowns etc. you will either need to keep it as a platform (like now) or as a sub-guide of Kotlin. Adding it as a guide will also open up the possibility of using a shared common folder, platform-includes etc. Otherwise it would be just a sub-page that has it's own content.

Adding it as a guide vs adding it as a sub page of kotlin will also impact search results as they are always scoped to guides or platforms (if applicable) – which should not be a big issue here I guess

@kahest kahest moved this from Needs Discussion to Needs Review in Mobile SDKs Jan 10, 2025
@github-project-automation github-project-automation bot moved this from Needs Review to Done in Mobile SDKs Jan 16, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Feb 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Archived in project
Archived in project
Development

Successfully merging a pull request may close this issue.

7 participants
@bruno-garcia @kahest @chargome @coolguyzone @buenaflor @lizokm and others