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

Explain how to set TypeScript up for using with jk #319

Open
squaremo opened this issue Feb 13, 2020 · 2 comments
Open

Explain how to set TypeScript up for using with jk #319

squaremo opened this issue Feb 13, 2020 · 2 comments
Labels
help wanted Extra attention is needed topic/documentation

Comments

@squaremo
Copy link
Member

No description provided.

@shimmerjs
Copy link

shimmerjs commented Jul 22, 2020

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)

@squaremo
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed topic/documentation
Projects
None yet
Development

No branches or pull requests

2 participants