| Message ID | 20190501031643.15853-1-ruscur@russell.cc |
|---|---|
| State | Accepted |
| Headers | show |
| Series | README: add .env file to installation instructions | expand |
Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> On 1/5/19 1:16 pm, Russell Currey wrote: > Creating the .env file is mentioned in the installation documentation > but not in the README, so following only the steps mentioned there will > fail. Add this and add a `cd patchwork` in there for good measure so > you could straight up copy paste the steps. > > Signed-off-by: Russell Currey <ruscur@russell.cc> > --- > README.rst | 9 +++++++-- > 1 file changed, 7 insertions(+), 2 deletions(-) > > diff --git a/README.rst b/README.rst > index 38c1847..b45c3e6 100644 > --- a/README.rst > +++ b/README.rst > @@ -61,11 +61,16 @@ environment. To install Patchwork: > > $ git clone https://github.com/getpatchwork/patchwork.git > > -3. Build the images. This will download over 200MB from the internet:: > +3. Create a ``.env`` file in the root directory of the project and store your > + ``UID`` attribute there:: > + > + $ cd patchwork && echo "UID=$UID" > .env > + > +4. Build the images. This will download over 200MB from the internet:: > > $ docker-compose build > > -4. Run `docker-compose up`:: > +5. Run `docker-compose up`:: > > $ docker-compose up > >
Sounds good, applied. Russell Currey <ruscur@russell.cc> writes: > Creating the .env file is mentioned in the installation documentation > but not in the README, so following only the steps mentioned there will > fail. Add this and add a `cd patchwork` in there for good measure so > you could straight up copy paste the steps. > > Signed-off-by: Russell Currey <ruscur@russell.cc> > --- > README.rst | 9 +++++++-- > 1 file changed, 7 insertions(+), 2 deletions(-) > > diff --git a/README.rst b/README.rst > index 38c1847..b45c3e6 100644 > --- a/README.rst > +++ b/README.rst > @@ -61,11 +61,16 @@ environment. To install Patchwork: > > $ git clone https://github.com/getpatchwork/patchwork.git > > -3. Build the images. This will download over 200MB from the internet:: > +3. Create a ``.env`` file in the root directory of the project and store your > + ``UID`` attribute there:: > + > + $ cd patchwork && echo "UID=$UID" > .env > + > +4. Build the images. This will download over 200MB from the internet:: > > $ docker-compose build > > -4. Run `docker-compose up`:: > +5. Run `docker-compose up`:: > > $ docker-compose up > > -- > 2.21.0 > > _______________________________________________ > Patchwork mailing list > Patchwork@lists.ozlabs.org > https://lists.ozlabs.org/listinfo/patchwork
diff --git a/README.rst b/README.rst index 38c1847..b45c3e6 100644 --- a/README.rst +++ b/README.rst @@ -61,11 +61,16 @@ environment. To install Patchwork: $ git clone https://github.com/getpatchwork/patchwork.git -3. Build the images. This will download over 200MB from the internet:: +3. Create a ``.env`` file in the root directory of the project and store your + ``UID`` attribute there:: + + $ cd patchwork && echo "UID=$UID" > .env + +4. Build the images. This will download over 200MB from the internet:: $ docker-compose build -4. Run `docker-compose up`:: +5. Run `docker-compose up`:: $ docker-compose up
Creating the .env file is mentioned in the installation documentation but not in the README, so following only the steps mentioned there will fail. Add this and add a `cd patchwork` in there for good measure so you could straight up copy paste the steps. Signed-off-by: Russell Currey <ruscur@russell.cc> --- README.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)