readme

README.md

@@ -38,6 +38,10 @@ In order to use the project manager you have to execute it once
 
 ![](.images/create-project.png)
 
+## Workspace directories
+
+![](.images/workspace-created-directories.png)
+
 ## Configure your project
 
 ![](.images/configure-your-project.png)

etc/.config_template

@@ -8,22 +8,28 @@ app_project_manager_dir=""
 
 ### STAGE
 
+# The httpdocs folder on your server
 stage_httpdocs_path=""
+
+# subpath from httpdocs to your installation of the project
 stage_httpdocs_git_subpath=""
-stage_httpdocs_shopware_subpath=""
 
 ### LIVE
 
+# The httpdocs folder on your server
 live_httpdocs_path=""
+
+# subpath from httpdocs to your installation of the project
 live_httpdocs_git_subpath=""
-live_httpdocs_shopware_subpath=""
 
 ### LOCAL STAGE
 
+# url to your project on the local machine
 local_stage_host=""
 
 ### LOCAL LIVE
 
+# url to your project on the local machine
 local_live_host=""
 
 ### POST SCRIPT

plugins/db/etc/.config_template

@@ -9,6 +9,7 @@ db_stage_name=""
 db_stage_user=""
 db_stage_password=""
 
+# the admmin user is used to create and drop databases
 db_stage_admin_user=""
 db_stage_admin_password=""
 
@@ -21,11 +22,14 @@ db_live_name=""
 db_live_user=""
 db_live_password=""
 
+# the admmin user is used to create and drop databases
 db_live_admin_user=""
 db_live_admin_password=""
 
 ### LOCAL_STAGE
 
+# you can drive you local installation with a copy of stage or live
+
 db_local_stage_socket=""
 db_local_stage_host=""
 db_local_stage_port=""
@@ -33,11 +37,14 @@ db_local_stage_name=""
 db_local_stage_user=""
 db_local_stage_password=""
 
+# the admmin user is used to create and drop databases
 db_local_stage_admin_user=""
 db_local_stage_admin_password=""
 
 ### LOCAL_LIVE
 
+# you can drive you local installation with a copy of stage or live
+
 db_local_live_socket=""
 db_local_live_host=""
 db_local_live_port=""
@@ -45,5 +52,6 @@ db_local_live_name=""
 db_local_live_user=""
 db_local_live_password=""
 
+# the admmin user is used to create and drop databases
 db_local_live_admin_user=""
 db_local_live_admin_password=""

plugins/git/etc/.config_template

@@ -2,7 +2,10 @@
 
 ### GIT
 
+# where is your project located in git
 git_url=""
+
+# optionaly you can let empty and use https with password
 git_ssh_user=""
 git_ssh_domain=""
 git_ssh_private_key=""