README.md

Stakater Cloud Documentation Landing Page

Docs are built using MkDocs which is based on Python.

GitHub Actions

This repository has Github action workflow which checks the quality of the documentation and builds the Dockerfile image on Pull Requests. On a push to the main branch, it will create a GitHub release and push the built Dockerfile image to an image repository.

Build Dockerfile image and run container

Build Dockerfile image:

$ docker build . -t test

Run container:

$ docker run -p 8080:8080 test

Then access the docs on localhost:8080.

Build locally

It is preferred to build and run the docs using the Dockerfile image, however an alternative is to run the commands locally.

Use virtualenvwrapper to set up Python virtual environments.

Install Python 3.

Install mkdocs-material and mermaid plugin:

$ pip3 install mkdocs-material mkdocs-mermaid2-plugin

Finally serve the docs using the built-in web server which is based on Python http server - note that the production build will use Nginx instead:

$ mkdocs serve