Updating documentation (this website)
This project uses the Diátaxis technical documentation framework. The website is generated using Material for MkDocs and can be viewed at k8s-gitops.fullstackjam.com.
There are 4 main parts:
- Getting started (tutorials): learning-oriented
- Concepts (explanation): understanding-oriented
- How-to guides: goal-oriented
- Reference: information-oriented
Local development
To edit and view locally, run:
make tools
mkdocs serve
Then visit localhost:8000