MyCompany Handbook

Html version: https://harobed.github.io/team-handbook/

Why?

See Handbook Usage - Advantages section.

Inspiration

This Handbook is inspired by:

• CreativeCommons GitLab Handbook

Handbook is powered by:

• MkDocs
• and Material for MkDocs theme

Update directly in GitLab

You can browse, read and edit MyCompany Handbook pages directly in GitLab repository team-handbook.

Test MyCompany Handbook locally

Prerequisite

• Docker and docker-compose

Prerequisites installation with Brew:

$ brew cask install docker
$ brew install docker-compose

Start

$ make up
...
Open http://0.0.0.0:8000

Next live update Handbook in src/ directory.

Stop:

$ make down

Deployment

See production/README.md.

How to customize Team-Handbook

Set your company name in scripts/rename.sh file and excute it to update all markdown files.