ziti-doc icon indicating copy to clipboard operation
ziti-doc copied to clipboard

android quickstart is a dead end

Open qrkourier opened this issue 2 years ago • 3 comments

There's a docs page for the Android quickstart that's built from this GitHub repo's README, but when a visitor arrives on the page they are not linked to the repo or its contents, and so it is a dead end (they're not able to complete the quickstart). I created this PR to address that issue.

qrkourier avatar Apr 20 '23 15:04 qrkourier

This seems like a better entrypoint to Android dev: https://github.com/openziti/ziti-sdk-android#readme

It links to the quickstart too, so if we build this readme into docs as the Android landing page then it won't be a dead end.

qrkourier avatar Apr 20 '23 15:04 qrkourier

The front page of ziti-docs has a Kotlin tile labeled "Android" that points to https://github.com/openziti/ziti-sdk-jvm/tree/main/samples. In this case too, https://github.com/openziti/ziti-sdk-android#readme seems like a better link target / entrypoint for Android development.

qrkourier avatar Apr 20 '23 16:04 qrkourier

@dovholuknf Thanks for the review. That will address the dead-end problem.

I also gave a couple of examples where I think https://github.com/openziti/ziti-sdk-android#readme is better content to show for Android SDK in the docs site. We're currently showing the Android quickstart repo's README, but the Android SDK repo has a more appropriate content for this. We could still link to the Android quickstart in the Android SDK's README.

qrkourier avatar Jun 26 '23 16:06 qrkourier