squaremo
commented
4 years ago That's a generous offer, thank you! "How To" documentation -- a guide, walkthrough, worked example -- would be the most useful, I reckon. I would put it in the docs, under the heading "How to" in the navigation.
The way the docs get made into a website is a little tricky to trace through. Basically: content goes in https://github.com/jkcfg/website/tree/master/static/docs, and navigation is defined in https://github.com/jkcfg/website/blob/master/src/pages/navigation.json. You can run the website locally -- instructions in the README https://github.com/jkcfg/website/blob/master/README.md.
I have been using jk with TypeScript exclusively since I adopted it in January (for both compiling node.js to be consumed by jk directly and publishing compatible node modules to npm) and would be happy to contribute something back to the project. What kind of explanation were you thinking, a walk through under
examples/or an explicit section of the docs?re: examples, I have written a decent amount of "app" definitions in TypeScript for jk that I could clean up and add write-ups to (https://github.com/digital-plumbers-union/jkcfg/tree/master/apps) and I manage my personal k3s cluster manifests mostly via jkcfg (https://github.com/booninite/manifests)