To access the KubeKit Documentation go to https://github.com/pages/liferaft/kubekit/. This document only explain how to edit the documentation.
Most of the documents were created in Markdown then exported to HTML. To edit the documents it’s recommended to use a Markdown editor such as Typora or VSCode with a Markdown preview plugin like Mermaid Preview but for small changes any editor is fine.
The flowcharts were done using Mermaid, edited and exported to HTML with Typora.
There is one flowchart per document, each flowchart cover a kubekit command, i.e. commands init used as kubekit init --cluster name
For more information about Mermaid go to:
To export the Mermaid Markdown to HTML using Typora, open and edit the Markdown document (i.e. init.md) then export it to HTML with the menu option File -> Export -> HTML.
Verify the changes with a browser going to the generated html file using file://, i.e. file:///Users/ja186051/Workspace/src/github.com/liferaft/kubekit/docs/init.html. After pushing the changes to master branch, double check going to the github page, i.e. https://github.com/pages/liferaft/kubekit/init.html.