search

asobti / kube-monkey

An implementation of Netflix's Chaos Monkey for Kubernetes clusters
Apache License 2.0
2.96k stars 252 forks source link

Documentation site for Kube-Monkey #236

Open dewan-ahmed opened 2 years ago

dewan-ahmed commented 2 years ago

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.

worldtiki commented 2 years ago

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?