Here we collect definitions and brief explanations of some patterns that might be relevant for software architecture.
It's powered by Jekyll and a modified TTSCK theme (see below).
As all of the arc42 content, this FAQ is free to use under a liberal Creative-Commons license:
- open an issue in our issue tracker
- fork the repo, fix bugs and send a pull request
- Install docker
- For development, run
docker-compose up
-
A docker image will be built and the development-server will be started.
-
In case you want to publish the site, terminate the development server by pressing Ctrl-C in your shell and run
docker-compose down. Then start a production build of the site:
docker-compose -f docker-compose-prod.yml up
The complete site will be generated into the folder zz_site- you
may ftp or rcp this to your production webserver.
- Install Jekyll
- Checkout/fork this repository
- Open a shell in the root directory and execute the following commands:
bundle install;
bundle update
- Then you should be able to start a local Jekyll server to test your installation:
bundle exec jekyll serve --config _config-localhost.yml
- Open
http://localhost:4000in your browser and enjoy your generated site.
- Ruby installed (version 2.1 preferred, 2.4 didn't work for me)
- Unix or MacOS, getting Jekyll to work on Windows lies beyond my abilities
- some terminal proficiency
For documentation on this theme, see the original documentation.
We implemented several enhancements over the original theme (e.g. responsive navigation, thx to Falk Hoppe)