manuals first files

manual/README.md

@@ -0,0 +1,30 @@
+Manual
+======
+
+Each script `${FULL_SCRIPTNAME}.sh` has it's corresponding manual here:
+ - `manuals/${FULL_SCRIPTNAME}.sh.md`
+
+According to the rule above, this directory `manuals/core/*`  
+has the same structure as `../core/*` and contains all manuals explaining the core functionality.
+
+And this directory `manuals/script/*`  
+has the same structure as `../script/*` and contains all manuals explaining the purpose of each script.
+
+
+
+Core functionality
+------------------
+
+This set of scripts is the absolute minimum to provide the core functionality:
+ - `setupCoreOntoThisHost.sh` bootstraps an empty new host, after the scripts repository was cloned  
+   [Read this for further details](./setupCoreOntoThisHost.sh.md)
+ - `setupCoreOntoThisHost.sh` needs [`../core/addAndCheckGitRepository.sh`](./core/addAndCheckGitRepository.sh.md)
+ - `setupCoreOntoThisHost.sh` needs [`../core/addNormalUser.sh`](./core/addNormalUser.sh.md)
+ - `setupCoreOntoThisHost.sh` needs [`../core/addToCrontabEveryHour.sh`](./core/addToCrontabEveryHour.sh.md)
+ - `setupCoreOntoThisHost.sh` needs [`../core/defineAuthorizedKeysOfUser.sh`](./core/defineAuthorizedKeysOfUser.sh.md)
+ - `setupCoreOntoThisHost.sh` needs [`../core/ensureUsageOfDefinitions.sh`](./core/ensureUsageOfDefinitions.sh.md)
+
+
+
+The scripts
+-----------

manual/core/addNormalUser.sh.md

@@ -0,0 +1,8 @@
+[core/addNormalUser.sh](..//core/addNormalUser.sh)
+==================================================
+
+This script adds a normal user to the host on which it was called.
+
+__Parameters:__
+  1. USER (mandantory)
+          Name of the user who will be added to the host

manual/core/defineAuthorizedKeysOfUser.sh.md

@@ -0,0 +1,8 @@
+[core/defineAuthorizedKeysOfUser.sh](../core/defineAuthorizedKeysOfUser.sh)
+===========================================================================
+
+This script defines the `authorized_keys` file of the given user.
+It will create a link pointing to the file in definitions to distribute the same settings across all hosts.
+
+__Parameters:__
+  1. USER (mandantory) Name of the user who will receive the ssh settings.

manual/script/host/README.md

@@ -0,0 +1,9 @@
+script/host
+===========
+
+This folder contains scripts managing the host.  
+For example:
+  - certificates
+  - git
+  - ssh
+  - users

manual/script/host/user/README.md

@@ -0,0 +1,4 @@
+script/host/user
+================
+
+This folder contains scripts managing users of a host.