/quality.arc42.org-site

Quality requirements and goals for software and system architectures

Primary LanguageSCSSCreative Commons Zero v1.0 UniversalCC0-1.0

arc42 Quality model

Here we collect definitions of quality attributes and their relationships .

It's powered by Jekyll and a modified TTSCK theme (see below).

License

As all of the arc42 content, this FAQ is free to use under a liberal Creative-Commons license:

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

Jekyll TTSCK Theme

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)

How to build & run

Preconditions

You have an environment that allows to run

Build

In the root directory you find the script _manage-site.sh. Run it:

quality.arc42.org-site (main)$ ./_manage-site.sh.

Once executed the script suggests the possible commands. Only after you have chosen a command it will actually do something, i.e. to build and run it. The script starts a server with the updated website that you access via http://localhost:4000.

How to contribute

Create a fork of https://github.com/arc42/quality.arc42.org-site. Change files and create a pull request with your changes using your fork.

Hint: _todo-qualities contains qualities whose definitions are missing. You may fill those files with content. Then move them to the appropriate folder (e.g. qualities/<letter>/_posts).

Hint: If you add new files you have to clean-rebuild the whole application. The watch is only for modifications of existing files.