kube-monkey icon indicating copy to clipboard operation
kube-monkey copied to clipboard

Published 20 hours ago • verified publisher icon asobti

Documentation site for Kube-Monkey

Open dewan-ahmed opened this issue 2 years ago • 1 comments

While the existing README is a great start, this project can use a documentation site since it's growing fast (Yayy!!)

Options:

  1. https://argo-cd.readthedocs.io/en/latest (readthedocs)
  2. https://github.com/kubernetes/website (GitHub/Netlify), Hugo/GitHubPages, or other combinations
  3. Something else?

Happy to contribute as well.

dewan-ahmed avatar Aug 03 '22 16:08 dewan-ahmed

We already use github pages as a way to publish helm charts (https://github.com/asobti/kube-monkey/tree/gh-pages) but I'm sure we can have them for both charts + docs.

I've used mkdocs material in other projects and I'd definitely recommend using this (https://squidfunk.github.io/mkdocs-material/) but happy to hear about alternatives.

Thoughts @asobti?

worldtiki avatar Aug 03 '22 16:08 worldtiki