This repository contains the source for the Adfinis SyGroup Architecture documentation.

The documentation is structured according to the arc42 software architecture documentation template.

The architecture documentation in the repo get rendered into static HTML pages by hugo. The resulting page is then deployed to GitHub Pages through travis.

After installing hugo as per the installation docs you may run hugo to start a local development server on port 1313.

hugo server

You can now make changes to the markdown files in the docs/ subdirectory and hugo will watch the directory and reload your browser on each change.

If you do not wish to install hugo locally you may start the development server in a docker container.

docker run --rm -ti -p 1313:1313 -v $(pwd):/src jojomi/hugo hugo server --bind 0.0.0.0

As with the local installation you can now connect to the development server on port 1313 and the page will automatically get reloaded if you make changes to the files in docs/.

The deployment of the final page to GitHub Pages is automated through travis. Please look at .travis.yml for details on the CI/CD process.

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

© We acknowledge that this document uses material from the arc 42 architecture template, http://www.arc42.de. Created by Dr. Peter Hruschka & Dr. Gernot Starke.