Ktor: Documentation

[BugsBunnyBR]

Hi, I would like to have some documentation of ktor before using it. The Wiki has some links with empty content.

[orangy]

Agree. What would be 5 top topics to cover first?

[BugsBunnyBR]

• Application Lifecycle
• Pipeline
• Feature Authentication
• Location
• Hosting

Would be nice to have a README.MD explaining each ktor-samples main goal or the wiki documentation could use the ktor-samples as code samples to each feature.

[BugsBunnyBR]

I did not reply with any priority order, but I think Hosting would be nice to see first together with a "How to run a hello world"

[BugsBunnyBR]

Maybe it can help in a section Hello world with gradle
https://github.com/BugsBunnyBR/base-ktor-gradle

[tmseiler]

Definitely agreed, here -- I wish I had found your demo before getting started. Being new to gradle/maven, I had a hard time figuring out exactly what to include to resolve the dependencies. Luckily the folks on slack were very helpful.

[orangy]

I created a "PR-able" repository for wiki: https://github.com/Kotlin/ktor-wiki
Would you mind contributing Gradle.md with description how to setup Ktor application with gradle, step by step?

[PascalLeMerrer]

Hello
Ktor sounds interesting, but the lack of documentation is a no go for me.

[hhariri]

@PascalLeMerrer We're adding documentation. Have you checked out the wiki? Most of the items in this issue are already there or being worked on.

[PascalLeMerrer]

Yes, I've checked it again yesterday, and although I've seen progress compared to what it was a few months ago, there are still blank pages, and it seems quite light for a documentation. So it remains a bit too early to adopt it for me.
Anyway, it's great to know you're working on it, and I hope it will be mature enough to use it on my next Kotlin project. Thanks for your efforts!

[altavir]

Documentation is messed up. Some links in the Wiki lead not to the places they mean to. Most of the classes I've searched not even documented in the source code.
I am considering moving from Ratpack to Ktor (since I generally like Kotlin more than Groovy), but currently I can't find my way around. For example, I need to change routing after application is started. In Ratpack it is done by reloading configuration, but I can't see how it could be done in Ktor.

[binhonglee]

So uhh... Where should I go for any kind of documentation now? The link above is dead and official website barely has anything (that actually works) in it.

[qwertukg]

@binhonglee In official Ktor repo u can find a lot of examples. Did u try it?

[binhonglee]

@qwertukg This is the official repo right? Or is there a different repo? I tried for example in this page, does this

import io.ktor.html.*

as seen on that page but was thrown an error (saying that package doesn't exist) while all the other ktor import was fine. Still couldn't figure out how to do a respondHtml.

[orangy]

@binhonglee did you add a dependency to ktor-html-builder module?

[binhonglee]

@orangy Thanks! That fixed the problem. But yea, I ended up opting for Spark instead.