Improved documentation and examples

Author: Wtower

README.md

@@ -59,3 +59,100 @@ See the folder `examples/`:
 
 - `django_deploy.yml`: playbook example
 - `django_sites.yml`: configuration example
+
+Task description
+----------------
+
+1. Check that project path in dev as specified in configuration is valid and has wsgi script
+
+   Checks that there is a valid local path specified in `django_sites.yml` and an `index.wsgi` exists.
+   Avoids deploying wrong files.
+
+2. Check if gulp file exists
+
+   So that to execute next step.
+
+3. Execute gulp
+
+   Execute `gulp --production` locally.
+
+4. Set Python executable
+
+   Auxiliary task which sets a variable with the Python executable.
+
+5. Make virtualenv
+
+   Create a virtualenv if it does not exist.
+
+6. Configure Apache
+
+   Configure Apache to execute the wsgi script using the provided template file.
+   Only executes if a `domain_name` is provided.
+   If the configuration changes, causes Plesk to reconfigure the domain in the end (notifies handler).
+   If the configuration changes, causes Apache to restart in the end (notifies handler).
+
+7. Configure New Relic
+
+   If `newrelic` is defined configures New Relic.
+
+8. Open ownership
+
+   Open the target directory ownership to allow file copy.
+
+9. Sync files
+
+   Syncs files to target directory.
+
+   :warning: Make sure that you have synced back any user uploaded files in `media` with manual `rsync`. 
+
+10. Upgrade pip
+
+    Upgrades pip, setup, wheel. 
+
+11. Install pip requirements
+
+    Install `requirements.txt` in virtualenv.
+
+12. Set Django admin executable
+
+    Auxiliary task which sets a variable with the Django admin executable.
+
+13. Set Django admin settings
+
+    Auxiliary task which sets a variable with the custom settings file (default `django_settings` variable).
+
+14. Migrate
+
+    Runs migrations.
+
+15. Flush data
+
+    Flushes data if `loaddata` and `flush` are both true.
+
+16. Load data
+
+    Loads data if `loaddata` is true.
+
+17. Collect static
+
+    Runs collect static.
+
+18. Compile messages
+
+   Compiles i18n messages if `compile_msgs` is true.
+
+19. Clear cache
+
+   Clears cache if `memcached` is true.
+
+20. Post deployment script
+
+    Runs an optional `post_script`.
+
+21. Close ownership to Plesk account group
+
+    Reset target directory ownership to the appropriate Plesk permissions.
+
+22. Close ownership to Plesk server group
+
+    Reset target directory ownership to the appropriate Plesk permissions.

examples/django_deploy.yml

@@ -23,4 +23,4 @@
       when: django_sites[project].disabled is defined
 
   roles:
-    - django_deploy
+    - Wtower.django_deploy

examples/django_sites.yml

@@ -1,7 +1,15 @@
 ---
 django_sites:
   myproject:
-    name: My Project
+    disabled: false
+    date: 19/3/2015
+    app_name: My Project
     domain_name: myproject.com
+    dev_path: ~/workspace/python/project
     host_path: /var/www/vhosts/mysite.com/myproject.com
+    host_user: username
     python_version: 3.4
+    memcached: true
+    data:
+      - auth
+      - app2