[v2] docs: set the GID in the .env file
diff mbox series

Message ID 20200212033614.11765-1-lukas.bulwahn@gmail.com
State New
Headers show
Series
  • [v2] docs: set the GID in the .env file
Related show

Commit Message

Lukas Bulwahn Feb. 12, 2020, 3:36 a.m. UTC
From: Pranav Annam <pranavannam@gmail.com>

The .env file needs the UID and GID for a working docker-compose build.

If you follow the current instructions, the docker build fails with a
clear error message: 'You must define GID in .env'

It is still good to update documentation to reduce the burden on new
contributors to run into this build failure first.

Signed-off-by: Pranav Annam <pranavannam@gmail.com>
[simply provide bash command in docs, reworked commit message]
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
 docs/development/installation.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Daniel Axtens Feb. 17, 2020, 12:02 p.m. UTC | #1
I was sure I had sent a patch for this thing before, and sure enough, I
had: commit f6f297e74a5a ("README: fix .env")

As it turns out I had only fixed README.md, not the docs. My method in
README.md is different, but also a bit more obtuse. So while in theory I
think it's good to have the method the same, in practise I'm not going
to try to standarise it right now!

All of which is a long way to say, I have applied your patch.

Pranav, welcome to the Patchwork project! We're not super quick at
responding (Stephen and I), so thanks for your patience. I can't speak
for Stephen, but for me, my day-job is only tangentially patchwork
related, so I tend to do things in unpredictable bursts. I hope that
with Lukas' wise guidance that won't be too much of a problem for you!

Regards,
Daniel

Lukas Bulwahn <lukas.bulwahn@gmail.com> writes:

> From: Pranav Annam <pranavannam@gmail.com>
>
> The .env file needs the UID and GID for a working docker-compose build.
>
> If you follow the current instructions, the docker build fails with a
> clear error message: 'You must define GID in .env'
>
> It is still good to update documentation to reduce the burden on new
> contributors to run into this build failure first.
>
> Signed-off-by: Pranav Annam <pranavannam@gmail.com>
> [simply provide bash command in docs, reworked commit message]
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---
>  docs/development/installation.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/docs/development/installation.rst b/docs/development/installation.rst
> index 03ad67a..0a6e71c 100644
> --- a/docs/development/installation.rst
> +++ b/docs/development/installation.rst
> @@ -25,11 +25,12 @@ configure Patchwork using Docker:
>  #. Install `docker`_ and `docker-compose`_.
>  
>  #. Create a ``.env`` file in the root directory of the project and store your
> -   ``UID`` attribute there.
> +   ``UID`` and ``GID`` attribute there.
>  
>     .. code-block:: shell
>  
>        $ echo "UID=$UID" > .env
> +      $ echo "GID=`id -g`" >> .env
>  
>  #. Build the images. This will download over 200MB from the internet:
>  
> -- 
> 2.17.1
>
> _______________________________________________
> Patchwork mailing list
> Patchwork@lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/patchwork

Patch
diff mbox series

diff --git a/docs/development/installation.rst b/docs/development/installation.rst
index 03ad67a..0a6e71c 100644
--- a/docs/development/installation.rst
+++ b/docs/development/installation.rst
@@ -25,11 +25,12 @@  configure Patchwork using Docker:
 #. Install `docker`_ and `docker-compose`_.
 
 #. Create a ``.env`` file in the root directory of the project and store your
-   ``UID`` attribute there.
+   ``UID`` and ``GID`` attribute there.
 
    .. code-block:: shell
 
       $ echo "UID=$UID" > .env
+      $ echo "GID=`id -g`" >> .env
 
 #. Build the images. This will download over 200MB from the internet: