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.

Sign up for GitHub

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

Jump to bottom

Documentation site for Kube-Monkey #236

Open

dewan-ahmed opened this issue Aug 3, 2022 · 1 comment

dewan-ahmed commented Aug 3, 2022

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

Options:

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

Happy to contribute as well.

Collaborator

worldtiki commented Aug 3, 2022

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment