[PATCH] docs: Clarify docker instructions

Stephen Finucane stephen at that.guru
Wed Feb 8 08:48:10 AEDT 2017


It's possible to run 'manage.py' commands when using the Docker
container but this is not documented anywhere. Clarify this.

Signed-off-by: Stephen Finucane <stephen at that.guru>
Cc: Daniel Axtens <dja at axtens.net>
---
 docs/development/installation.md | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/docs/development/installation.md b/docs/development/installation.md
index cfcc63a..bf1ff5b 100644
--- a/docs/development/installation.md
+++ b/docs/development/installation.md
@@ -29,25 +29,34 @@ configure Patchwork using Docker:
 
 To run a shell within this environment, run:
 
-    $ docker-compose run --rm web --shell
+    $ docker-compose run web --shell
+
+To run django-manage commands, such as `createsuperuser` or `migrate`, run:
+
+    $ docker-compose run web python manage.py createsuperuser
 
 To run unit tests, excluding Selenium UI interaction tests, using only the
 package versions installed during container initialization, run:
 
-    $ docker-compose run --rm web --quick-test
+    $ docker-compose run web --quick-test
 
 To run the same against all supported versions of Django (via tox), run:
 
-    $ docker-compose run --rm web --quick-tox
+    $ docker-compose run web --quick-tox
+
+To run specific tox targets or tests, pass arguments to the above:
+
+    $ docker-compose run web --quick-tox -e py27-django17 \
+        patchwork.tests.test_bundles
 
 To run all tests, including Selenium UI interaction tests, using only the
 package versions installed container initialization, run:
 
-    $ docker-compose run --rm web --test
+    $ docker-compose run web --test
 
 To run the same against all supported versions of Django (via tox), run:
 
-    $ docker-compose run --rm web --tox
+    $ docker-compose run web --tox
 
 To run all tests, including Selenium UI interaction tests in non-headless mode,
 run:
-- 
2.9.3



More information about the Patchwork mailing list