From 94197ba0d866d493a5490fa28321a8b8327a20dc Mon Sep 17 00:00:00 2001
From: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
Date: Tue, 13 Jan 2015 03:10:03 -0400
Subject: [PATCH] Update documentation and added steps to use the vagrant file

---
 docs/releases/1.1.rst        |  1 +
 docs/topics/development.rst  | 40 ++++++++++++++++++++++++++++++++++++
 docs/topics/installation.rst |  5 ++---
 3 files changed, 43 insertions(+), 3 deletions(-)

diff --git a/docs/releases/1.1.rst b/docs/releases/1.1.rst
index 0368311748..d51914deb3 100644
--- a/docs/releases/1.1.rst
+++ b/docs/releases/1.1.rst
@@ -48,6 +48,7 @@ What's new in Mayan EDMS v1.1
 * New home view
 * Explicit document types needed per index
 * Events app
+* Vagrant file included
 
 
 Upgrading from a previous version
diff --git a/docs/topics/development.rst b/docs/topics/development.rst
index 3388656f31..fc35f6834d 100644
--- a/docs/topics/development.rst
+++ b/docs/topics/development.rst
@@ -62,6 +62,46 @@ Steps to deploy a development version
     $ ./manage.py runserver
 
 
+Setting up a development version using Vagrant
+----------------------------------------------
+Make sure you have Vagrant and a provider properly installed as per https://docs.vagrantup.com/v2/installation/index.html
+
+Start and provision a machine using:
+
+.. code-block:: bash
+
+    $ vagrant up
+
+To launch a standalone development server
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+    $ vagrant ssh
+    vagrant@vagrant-ubuntu-trusty-32:~$ cd ~/mayan-edms/
+    vagrant@vagrant-ubuntu-trusty-32:~$ source venv/bin/activate
+    vagrant@vagrant-ubuntu-trusty-32:~$ ./manage.py runserver 0.0.0.0:8000
+
+To launch a development server with a celery worker and Redis as broker
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+    $ vagrant ssh
+    vagrant@vagrant-ubuntu-trusty-32:~$ cd ~/mayan-edms/
+    vagrant@vagrant-ubuntu-trusty-32:~$ source venv/bin/activate
+    vagrant@vagrant-ubuntu-trusty-32:~$ ./manage.py runserver 0.0.0.0:8000 --settings=mayan.settings.celery_redis
+
+Then on a separate console launch a celery worker from the same provisioned Vagrant machine:
+
+.. code-block:: bash
+
+    $ vagrant ssh
+    vagrant@vagrant-ubuntu-trusty-32:~$ cd ~/mayan-edms/
+    vagrant@vagrant-ubuntu-trusty-32:~$ source venv/bin/activate
+    vagrant@vagrant-ubuntu-trusty-32:~$ DJANGO_SETTINGS_MODULE='mayan.settings.celery_redis' celery -A mayan worker -l DEBUG -Q checkouts,mailing,uploads,converter,ocr,tools,indexing,metadata -Ofair
+
+
 Contributing changes
 --------------------
 Once your have create and committed some new code or feature, submit a Pull Request.
diff --git a/docs/topics/installation.rst b/docs/topics/installation.rst
index 3f7204eb84..91b7588c9b 100644
--- a/docs/topics/installation.rst
+++ b/docs/topics/installation.rst
@@ -40,7 +40,6 @@ it very easy to start using **Mayan EDMS**. Populate the database with the proje
 Point your browser to http://127.0.0.1:8000. If everything was installed
 correctly you should see the login screen and panel showing a randomly generated admin password.
 
-=======
 Mac OSX
 -------
 
@@ -76,7 +75,7 @@ to /usr/bin/ with ...
     sudo ln -s /opt/local/bin/tesseract /usr/bin/tesseract  && \
     sudo ln -s /opt/local/bin/identify /usr/bin/identify && \
     sudo ln -s /opt/local/bin/gs /usr/bin/gs
-    
+
 ... alternatively set the paths in the ``settings/locals.py``
 
 .. code-block:: python
@@ -111,7 +110,7 @@ to /usr/bin/ with ...
     sudo ln -s /usr/local/bin/unpaper /usr/bin/unpaper && \
     sudo ln -s /usr/local/bin/pdftotext /usr/bin/pdftotext && \
     sudo ln -s /usr/local/bin/gs /usr/bin/gs && \
-    
+
 ... alternatively set the paths in the ``settings/locals.py``
 
 .. code-block:: python