diff --git a/docs/10_Introduction/10_Installation_on_a_server.md b/docs/10_Get_started/10_Installation_on_a_server.md similarity index 100% rename from docs/10_Introduction/10_Installation_on_a_server.md rename to docs/10_Get_started/10_Installation_on_a_server.md diff --git a/docs/10_Introduction/20_Installation_with_Docker.md b/docs/10_Get_started/20_Installation_with_Docker.md similarity index 100% rename from docs/10_Introduction/20_Installation_with_Docker.md rename to docs/10_Get_started/20_Installation_with_Docker.md diff --git a/docs/10_Introduction/30_Filestructure.md b/docs/10_Get_started/30_Filestructure.md similarity index 85% rename from docs/10_Introduction/30_Filestructure.md rename to docs/10_Get_started/30_Filestructure.md index 000c6a505415e0c5557fe79617396803c87e31b1..14a7be05cd8f16e639c9926424d8247cccbf4557 100644 --- a/docs/10_Introduction/30_Filestructure.md +++ b/docs/10_Get_started/30_Filestructure.md @@ -6,7 +6,7 @@ ## Approot and website ## -Default: /var/www/[YOUR-DOMAIN]/ +Default: /var/www/[YOUR-DOMAIN]/public_html/ ```txt . @@ -25,10 +25,13 @@ Default: /var/www/[YOUR-DOMAIN]/ │ └── plugins │ ├── build │ │ └── tgz -│ └── rollout -│ ├── awx -│ ├── default -│ └── ssh +│ ├── rollout +│ │ ├── awx +│ │ ├── default +│ │ └── ssh +│ └── shellcmd +│ ├── load +│ └── processes ├── valuestore │ ├── classes │ ├── data diff --git a/docs/10_Introduction/40_Dependencies.md b/docs/10_Get_started/40_Dependencies.md similarity index 100% rename from docs/10_Introduction/40_Dependencies.md rename to docs/10_Get_started/40_Dependencies.md diff --git a/docs/20_Configuration/10_Configuration.md b/docs/20_Configuration/10_Configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..eb241ef4a1ada675073d6bc0960d1685e41a6837 --- /dev/null +++ b/docs/20_Configuration/10_Configuration.md @@ -0,0 +1,7 @@ +## Configuration + +The configuration is a combination of + +* config/config_defaults.php - containing shipped defaults (do not edit) +* config/config_custom.php - for your overrides of all default settings + diff --git a/docs/30_Server/Plugins/_index.md b/docs/30_Server/Plugins/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..f3398735425819212944147a5fdc486d3f3ea1f8 --- /dev/null +++ b/docs/30_Server/Plugins/_index.md @@ -0,0 +1,18 @@ +## Location and structure + +* Plugins are located `public_html/deployment/plugins/`. +* The directories in the first level are the plugin types +* The directories in the second level are the plugins of a type + +## Plugin conventions + +A plugin must have these files + +* config.json - configuration data (defaults) +* info.json - meta information file +* plugin.php +* render.js + +optional files: + +* lang_[language].json - language file for output diff --git a/docs/20_Server/Processes/10_Build.md b/docs/30_Server/Processes/10_Build.md similarity index 100% rename from docs/20_Server/Processes/10_Build.md rename to docs/30_Server/Processes/10_Build.md diff --git a/docs/20_Server/Processes/20_Rollout.md b/docs/30_Server/Processes/20_Rollout.md similarity index 100% rename from docs/20_Server/Processes/20_Rollout.md rename to docs/30_Server/Processes/20_Rollout.md diff --git a/docs/20_Server/Usage/10_Login.md b/docs/30_Server/Usage/10_Login.md similarity index 100% rename from docs/20_Server/Usage/10_Login.md rename to docs/30_Server/Usage/10_Login.md diff --git a/docs/20_Server/Usage/20_Project_overview.md b/docs/30_Server/Usage/20_Project_overview.md similarity index 100% rename from docs/20_Server/Usage/20_Project_overview.md rename to docs/30_Server/Usage/20_Project_overview.md