Skip to content

Introduction

This documentation site is based on Material for MkDocs. Similar to the main www.netsoc.ie site, any changes pushed to master are automatically deployed to the live site at docs.netsoc.ie. Most of the content actually comes from other individual repos under a docs/ subdirectory. Whenever changes are made to these repos' docs, they are pushed into the central docs repo.

Development

The Docker Compose file sets up a hot-reload development server. The site can be viewed at http://localhost:8000. The docs repo uses the build.yaml and charts.yaml GitHub Actions workflows as described in the IAM documentation.

Warning

To simulate the latest copies of documentation being pushed in the development environment, every individual repo is mounted separately into the container. This means that you must have all of the following repos cloned into the same directory as the docs repo:

Maintenance

  • When upgrading the Python version used to build the site, be sure to update both Dockerfile and Dockerfile.dev

Last update: 2021-08-24