Updated documentation, 1.5.0 pre release 2

docs/history.rst

@@ -7,13 +7,13 @@ History
 
 Versions come from git tags.
 
-Version 1.4.4 - Unreleased
+Version 1.5.0 - 2016/11/29
 --------------------------
 
-* Add files for use CI on project (with Jenkins/Fabric)
-* Clean code with flake8 and add a rule for run flake8 into the Makefile
-* Add django-datadownloader app
-* Add init migration script on contact_form app
+* Added files to use Continuous Integration (*CI*) with Jenkins/Fabric;
+* Cleaned code with flake8 and add a rule to run flake8 into Makefile;
+* Added ``django-datadownloader``;
+* Added initial migration for ``project.contact_form``;
 * Upgraded to ``django==1.8.16``, close #72;
 
 Version 1.4.4 - 2016/10/06

docs/install.rst

@@ -16,10 +16,7 @@ It's done.
 Created projects requirements
 *****************************
 
-.. NOTE::
-   If you allready have installed `Epaster`_, don't worry about this part.
-
-Although the template itself don't need anything but `Cookiecutter`_, a project created with this template will requires some libraries to build it and use it:
+Although the project template don't need anything but `Cookiecutter`_, a created project will requires some libraries to install it :
 
 * `virtualenv`_;
 * Python development library (commonly known as ``python-devel``);
@@ -36,4 +33,4 @@ The method to install them depends on your plateform :
 Also if you need to use a **PostgreSQL** database instead of the default **sqlite3** database, you will need a library to build **psycopg2**, this library is called ``libpq``.
 
 .. NOTE::
-   All created projects are shipped with a README file that contain all necessary details to build it and use it. This will be a simplified procedure with a **Makefile** command to launch the `buildout`_ process.
+   All created projects are shipped with a README file that should contains all necessary details to build it and use it. This will be a simplified procedure with a **Makefile** command to launch the `buildout`_ process.

docs/topics.rst

@@ -64,7 +64,7 @@ When it's done you can reach the gallery on: ::
 
     /icomoon/
 
-.. warning::
+.. WARNING::
    You need to be authenticated to view the gallery.
 
 .. NOTE::
@@ -168,6 +168,9 @@ Take care, an Egg that is installed from a repository url is validated on its ve
 PO-Projects
 ***********
 
+.. WARNING::
+   This is on the way to be deprecated since the PO-project server future is not known.
+
 **It aims to ease PO translations management** between developpers and translation managers.
 
 The `PO-Projects client`_ is pre-configured in all created projects but disabled by default. When enabled, its config file is automatically generated (in ``po_projects.cfg``), don't edit this file because it will be regenerated each time buildout is used.
@@ -204,17 +207,6 @@ Pull action
 
 Note that the client does not manage your repository, each time you change your PO files (from `Django`_ ``makemessages`` action or ``pull`` client action) you still have to commit them.
 
-Gestus
-******
-
-The `Gestus client`_ is pre-configured in all created projects, its config file is automatically generated (in ``gestus.cfg``), don't edit it because it will be regenerated each time buildout is used.
-
-You can register your environment with the following command : ::
-
-    gestus register
-
-Remember this should only be used in integration or production environment and you will have to fill a correct accounts in the ``EXTRANET`` part.
-
 Dr Dump
 *******
 

docs/usage.rst

@@ -6,12 +6,12 @@
 Usage
 =====
 
-Firstly, you produce the new project structure then deploy it locally and finally enjoy it (webdesign integration, development, etc..).
+Firstly, it will produce a new project structure then you will have to deploy it locally and finally enjoy it (webdesign integration, development, etc..).
 
-Produce project structure
-*************************
+Produced project structure
+**************************
 
-Quite simple, just invoke the `Cookiecutter`_ template to create a new project: ::
+Just invoke the `Cookiecutter`_ template to create a new project: ::
 
     cookiecutter https://github.com/emencia/cookiecutter-djangocms3-buildout
 
@@ -36,7 +36,7 @@ repo_host
 secret_key
     [Default:A random key]
 
-    The secret key to use in Django settings, you should let the default value.
+    The secret key to use in Django settings, you should let the default value (a randomly generated string).
 enable_accounts
     [Default:*no*]
 
@@ -65,16 +65,35 @@ enable_https
     [Default:*yes*]
 
     Use a dedicated nginx configuration to enable https only through *let's encrypt*.
+deploy_user
+    [Default:*django*]
+
+    System user where project will be deployed to (in its home directory).
+deploy_host
+    [Default: Empty]
+
+    Host where to to deploy project using ssh.
+changelog_mail_from
+    [Default: Empty]
+
+    Email 'from' adress use to send deployment informations.
+changelog_mail_to
+    [Default: Empty]
+
+    Email 'to' adress use to send deployment informations.
 
-Take care that question about applications require a strict "yes" value to enable them, all other value are considered as a "no".
 
 .. NOTE::
-   Once structure has been created, a git repository will be initialized on with a first commit.
+   Usually you won't need to care about fields starting with ``repo_`` or ``deploy_`` and just let their default values.
+
+Take care that question about applications require a strict ``yes`` value to enable them, all other value are considered as a ``no``.
+
+Once structure has been created, a GIT repository will be initialized with the right remote url and a first commit, ready to push.
 
 Deploy produced project
 ***********************
 
-Once a project has been created, you need to build it to use it. The process is simple. Do it in your project directory: ::
+When project has been created, you need to install it to use it. Do it in your project directory: ::
 
     make install
 

hooks/post_gen_project.py

@@ -17,7 +17,7 @@
 # from the template, either using "git describe" or package version because
 # hooks are applied from the created project and are unaware of cookiecutter
 # template location
-__version__ = "1.5.0-pre.1"
+__version__ = "1.5.0-pre.2"
 
 # Project directory path
 PROJECT_DIR = 'project'

requirements-dev.txt

@@ -2,4 +2,5 @@
 # Sphinx for documentation
 Pygments==1.6
 Sphinx==1.2.3
-sphinx-rtd-theme==0.1.6
+sphinx-rtd-theme==0.1.6
+sphinx-autobuild

{{cookiecutter.repo_name}}/Makefile

@@ -120,7 +120,7 @@ import_db:
 
 rm_sqlite:
 	@rm database.sqlite3
-  
+
 reset_sqlite: rm_sqlite import_db
 
 reload: