search

cloudstateio / kotlin-support

Cloudstate Kotlin Support
https://cloudstate.io/docs/user/lang/kotlin/index.html
Apache License 2.0
8 stars 5 forks source link

Add asciidoc-converted docs #52

Closed pvlugter closed 4 years ago

pvlugter commented 4 years ago

Convert the markdown/paradox kotlin support docs (from the main cloudstate repo) to asciidoc/antora.

It could be useful to have the example code that's included in the docs compiled and tested. It's currently just the source files. Note that for antora, the files need to be under modules/kotlin/examples. Could be included from where they are, or symlinked to a conventional location.

sleipnir commented 4 years ago

Hi @pvlugter, thanks for that PR.

Any way to ensure that the sample files are compiled and tested? Just point them to https://github.com/cloudstateio/kotlin-support/blob/master/examples/shopping-cart/src/main/kotlin/com/example/shoppingcart/ShoppingCartEntity.kt for example?

pvlugter commented 4 years ago

Yes, the samples can be compiled and tested. The only requirement for Antora is that the files stay under docs/src/modules/kotlin/examples — it's strict about having everything in a virtual filesystem, and doesn't support adding extra locations by default. So for java-support, there's a project that includes the examples directory as a source directory: https://github.com/cloudstateio/cloudstate/blob/master/build.sbt#L629. Or it can be symlinked (with the original under the Antora source tree).

sleipnir commented 4 years ago

Thanks Peter for PR

pvlugter commented 4 years ago

These docs published: https://cloudstate.io/docs/kotlin/