Changes

Modularisation

714 bytes added, 07:51, 24 April 2014
/* GitHub */
/helpers # Helper scripts and programmes, like notifications (quota, backup failed, rsnapshot, ...).
/provisioning # Scripts and programmes to provision services.
/schema # Description, validation specification and documentation of the REST API.
/web # Ajax based web interface.
/README.md # A simple readme file containing an overview and how to install as the absolute minimum.
* Tests (Unit-Tests, Test-Cases, Test-Data, ...).
* Documentation.
 
=== schema ===
The following shows how a '''schema''' directory structure could look like.
<pre>
/schema # Description, validation specification and documentation of the REST API.
/schema/core.schema.json # Every module has a master file, which includes all json files (the name is derived from the Git Repo module name)
/schema/base.schema.json # Type definitions.
/schema/reseller.schema.json # Per resource on file.
/schema/people.schema.json #
/schema/README.md # Information how the schema file(s) can be used and how the documentation can be extracted.
</pre>
=== helpers ===
SLB, editor, reviewer
3,368
edits