Repository containing wis2box training material (exercises, data, configuration).
The folder 'environment' provides documentation and materials used to run the local setup.
The wis2box-training is designed to be run on a local network containing all data, images and configurations.
A set of hardware (WiFi router and 3 mini-PCs) is brought along to local training sessions. The hardware setup will provide a dedicate student VM with Ubuntu and docker to each participant.
A local registry mirroring docker-hub is setup on the local hardware to reduce the time needed to download large docker-images in a low bandwidth environment.
All the contents of the folder 'exercise-materials' are added to the gh-pages during deployment in a single zip-file 'exercise-materials.zip'.
The practical sessions will start by asking the student to download this archive on their local machine and extracting it.
The workshop manual is powered by MkDocs which facilitates easy management and publishing of documentation. Workshop content is written in Markdown.
# build a virtual Python environment in isolation
python3 -m venv .
. bin/activate
# fork or clone from GitHub
git clone https://github.com/wmo-im/wis2box-training.git
cd wis2box-training/documentation
# install required dependencies
pip install -r requirements.txt
# build the website, output is in site/
mkdocs build
# serve locally
mkdocs serve # website is made available on http://localhost:8000To make contributions back to the workshop, fork the repository from GitHub. Contributions and Pull Requests are always welcome!
Changes to the GitHub repository result in an automated build and deploy of the content to wmo-im.github.io/wis2box-training.
Website updates are automatically published via GitHub Actions. To publish manually:
# NOTE: you require access privileges to the GitHub repository
# to publish live updates
mkdocs gh-deploy -m 'add new page on topic x'