stakater / saap-docs

Stakater App Agility Platform (SAAP) Documentation

Stakater App Agility Platform (SAAP) Documentation

SAAP 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 locally

There are at least three options to get fast continuous feedback during local development:

1. Build and run the docs using the Dockerfile image
2. Run the commands locally
3. Use Tilt

Build Dockerfile image and run container

Build Dockerfile test image:

$ docker build . -t test

Run test container:

$ docker run -p 8080:8080 test

Then access the docs on localhost:8080.

Run 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

or

$ python3 -m mkdocs serve

QA Checks

Markdown linting:

$ brew install markdownlint-cli
$ markdownlint -c .markdownlint.yaml content

Spell checking:

$ brew install vale
$ vale content

Use Tilt

Install Tilt, then run:

$ tilt up