Handbook

This is the repository for our public handbook.

For purely internal information we have our intranet.

Repository Overview

The content folder of this repository is served using the static site generator HUGO docs page. It is set up with the Google docsy theme and served at https://handbook.giantswarm.io/.

You can easily test and render any changes to the handbook with:

docker-compose build --pull
docker-compose up

Content changes are then auto-reloaded in the docker-compose setup.

Or for a simplified setup, run hugo server.

Auto-generated content needs to be rendered manually (make rfcs), as it's normally updated through a GitHub action.