kinvolk / lokomotive

🪦 DISCONTINUED Further Lokomotive development has been discontinued. Lokomotive is a 100% open-source, easy to use and secure Kubernetes distribution from the volks at Kinvolk
https://kinvolk.io/lokomotive-kubernetes/
Apache License 2.0
321 stars 49 forks source link

Add a thin top-level README to "important" directories #462

Open johananl opened 4 years ago

johananl commented 4 years ago

We should have a simple "overview" README in places like this: https://github.com/kinvolk/lokomotive/tree/master/docs/quickstarts

This README should list the contents of the directory with a short one-line description of each item.

invidian commented 4 years ago

IIRC the idea was to have the docs rendered with mkdocs or similar to the website. Do we want to have nice docs in GitHub too?