[PATCH v2] docs: clarify and improve docker dev docs
dja at axtens.net
Tue Jun 22 18:26:54 AEST 2021
The docker dev docs:
- had the links for docker and docker-compose swapped.
- had a old docker install link.
- lacked an up-front explanation of the requirement that a regular user
be able to manage the docker daemon (and a fairly unhelpful reference
link in the most appropriate note block.)
Fix it all.
Reported-by: Emily Shaffer <emilyshaffer at google.com>
Signed-off-by: Daniel Axtens <dja at axtens.net>
v2: properly use the link format. sigh.
docs/development/installation.rst | 20 ++++++++++++++------
1 file changed, 14 insertions(+), 6 deletions(-)
diff --git a/docs/development/installation.rst b/docs/development/installation.rst
index ff81229dfbd9..d16177ccd282 100644
@@ -22,7 +22,13 @@ Patchwork provides a Docker-based environment for quick configuration of a
development environment. This is the preferred installation method. To
configure Patchwork using Docker:
-#. Install `docker`_ and `docker-compose`_.
+#. Install `docker`_ and `docker-compose`_. _ Patchwork assumes that you
+ have Docker configured to allow a non-root user to manage Docker, as
+ outlined in the `Docker post-install instructions`__.
+ ..  Depending on your distro, `docker-compose` may also be available as a
+ __ post-install_
#. Create a ``.env`` file in the root directory of the project and store your
``UID`` and ``GID`` attribute there.
@@ -125,9 +131,10 @@ For more information on Docker itself, please refer to the `docker`_ and
ERROR: Couldn't connect to the Docker daemon at http+docker://localunixsocket - is it running?
- ensure you have correctly installed Docker, added your user to the
- ``docker`` group, and started the daemon, per the `docker documentation
+ ensure you have correctly installed Docker, and have followed the `Docker
+ post-install instructions`__.
+ __ post-install_
@@ -141,8 +148,9 @@ For more information on Docker itself, please refer to the `docker`_ and
-.. _docker: https://docs.docker.com/compose/install/
-.. _docker-compose: https://docs.docker.com/engine/installation/linux/
+.. _docker: https://docs.docker.com/engine/install/
+.. _docker-compose: https://docs.docker.com/compose/install/
+.. _post-install: https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user
More information about the Patchwork