jcabrerizo/k8s101

Helm notes and POC

Site 👉 https://jcabrerizo.github.io/k8s101/

k8s 101

Note

For reading the notes go to the docs dir or to the built site (TODO)

Docs managed with Material for Mkdocs

• getting starter: https://squidfunk.github.io/mkdocs-material/getting-started/

Run docs site locally

mkdocs serve

Set up

# create environment
python3.12 -m venv venv
# install mkdocs-material
python3.12 -m pip install mkdocs-material

TODO

• add index pages per each dir to improve experience while navigating on the repo instead of on the site. Those index should not interfere with the mkdoc table of content
• move code snipped in md files to independent files
• order content menu
• publish site -> https://jcabrerizo.github.io/k8s101/
• action to publish the site when merged / commit on main -> https://github.com/jcabrerizo/k8s101/blob/main/.github/workflows/build-and-publish-mkdocs.yaml
• git hook for format the md files