Fixed #77

Doc update to make it clear tasks must be executed from within the django environment
chris104957 · May 30, 2018 · bbda95d · bbda95d
1 parent 3adec71
commit bbda95d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -91,6 +91,9 @@ To schedule tasks to run at a given interval
     create_scheduled_task(my_task, {'seconds': 5}, hello=True)
 
 
+.. note::
+    The above commands must be made from within the Django environment
+
 Docker
 ------
 

diff --git a/docs/source/quick-start.rst b/docs/source/quick-start.rst
@@ -63,11 +63,16 @@ The daemon can be stopped/restarted as follows:
 For the full set of options, refer to :ref:`admin-command`
 
 
-Publishing tasks
-****************
+Creating and publishing tasks
+*****************************
+
+While the service is running, tasks will be consumed from your RabbitMQ queue. To test this, start the django shell:
+
+.. code-block:: bash
+
+    python manage.py shell
 
-While the service is running, tasks will be consumed from your RabbitMQ queue. To publish messages to the queue, use
-provided helper function:
+And use the provided helper, ``carrot.utilities.publish_message``:
 
 .. code-block:: python