ricsanfre / pi-cluster

Pi Kubernetes Cluster. Homelab kubernetes cluster automated with Ansible and ArgoCD

https://picluster.ricsanfre.com

MIT License

373 stars 57 forks source link

Feature Request: Move documentation to github pages #38

Closed ricsanfre closed 2 years ago

ricsanfre commented 2 years ago

Feature Request

Move cluster pi documentation to a website based on github pages and create a dedicated site picluster.ricsanfre.com

Implementation details

Move documentation to a docs directory and activate Github Pages.

ricsanfre commented 2 years ago

Tasks:

[x] Reorganize report structure moving ansible sobre code to root directory
[x] Create jekyll theme for the documentation website. Responsive website using Bootstrap 5.
- [x] Use as base jekyll-doc-theme
- [x] Update code to support latest versions Bootstrap (version 5.0), Bootswatch and Fontawesome
- [x] Add toc and off-canvas navigator menu apperaring for small screens (tablet/mobile)
- [x] Add search engine based on lunr.js
- [x] Add web analytics based on Matomo
- [x] Add commenting platform based on remarks42
[x] Updating md documents to jekyll website theme
[x] Create Quick start guide document
[x] Update README document
[x] Create README for jekyll website
[x] Configure Github Pages