MIME-Version: 1.0
References: <20211107171356.blv3eam3kacvf7mn@nixos>
In-Reply-To: <20211107171356.blv3eam3kacvf7mn@nixos>
From: Magnus Hagander <magnus@hagander.net>
Date: Mon, 8 Nov 2021 10:32:54 +0100
Message-ID: 
 <CABUevEzQgyJicsyH_QVcfr9u1wRYdmjY94B4Xj=aeQ=+v2iMFg@mail.gmail.com>
Subject: Re: [PATCH] Fix inaccuracies in documentation
To: Nils <nils@nilsand.re>
Cc: pgsql-www@lists.postgresql.org
Content-Type: multipart/alternative; boundary="0000000000001566b305d043ae1d"
Archived-At: 
 <https://www.postgresql.org/message-id/CABUevEzQgyJicsyH_QVcfr9u1wRYdmjY94B4Xj%3DaeQ%3D%2Bv2iMFg%40mail.gmail.com>
Precedence: bulk

--0000000000001566b305d043ae1d
Content-Type: text/plain; charset="UTF-8"

Hi!

Can I ask you to re-send this as an attachment, so the MUAs don't eat the
formatting?

Thanks!

//Magnus


On Sun, Nov 7, 2021 at 6:14 PM Nils <nils@nilsand.re> wrote:

> ---
>  docs/batch.rst       | 10 +++++-----
>  docs/dev_install.rst |  9 ++++-----
>  2 files changed, 9 insertions(+), 10 deletions(-)
>
> diff --git a/docs/batch.rst b/docs/batch.rst
> index 990f518d..c309d1fe 100644
> --- a/docs/batch.rst
> +++ b/docs/batch.rst
> @@ -12,11 +12,11 @@ All batch jobs are located in the directory tools/.
>
>  docs/docload.py
>  ---------------
> -This script will load a new set of documentation. Simply specify the
> -version to load and point out the tarball to load from. The script
> -will automatically decompress the tarball as necessary, and also
> -perform HTML tidying of the documentation (since the HTML generated by
> -the PostgreSQL build system isn't particularly standards-conforming or
> +This script will load a new set of documentation. Simply specify the
> version to
> +load and the path to the tarball of the PostgreSQL source code to load
> from.
> +The script will automatically decompress the tarball as necessary, and
> also
> +perform HTML tidying of the documentation (since the HTML generated by the
> +PostgreSQL build system isn't particularly standards-conforming or
>  nice-looking).
>
>  ftp/spider_ftp.py
> diff --git a/docs/dev_install.rst b/docs/dev_install.rst
> index b110efbb..9647e991 100644
> --- a/docs/dev_install.rst
> +++ b/docs/dev_install.rst
> @@ -34,9 +34,8 @@ with. Here's a quick step-by-step on how to do that:
>     There are some parts of the site that require further settings, but
>     this should be enough to get the basics up and running.
>
> -#. In the pgweb directory run the following command to create all
> -   tables and indexes, as well as create a superuser for your local
> -   installation::
> +#. Run the following command to create all tables and indexes, as well as
> +   create a superuser for your local installation::
>
>         ./manage.py migrate
>
> @@ -51,11 +50,11 @@ with. Here's a quick step-by-step on how to do that:
>         psql -d pgweb -f sql/varnish_local.sql
>
>  #. To load some initial data for some tables (far from all at this
> -   point), in the pgweb directory, run the following command::
> +   point), run the following command::
>
>         pgweb/load_initial_data.sh
>
> -#. You'll want to creaet a superuser so you can access the `/admin/`
> +#. You'll want to create a superuser so you can access the `/admin/`
>     interface::
>
>         ./manage.py createsuperuser
> --
> 2.31.1
>
>
>
>

--0000000000001566b305d043ae1d
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div>Hi!</div><div><br></div><div>Can I ask you to re-send=
 this as an attachment, so the MUAs don&#39;t eat the formatting?</div><div=
><br>Thanks!</div><div><br></div><div>//Magnus</div><div><br></div><br><div=
 class=3D"gmail_quote"><div dir=3D"ltr" class=3D"gmail_attr">On Sun, Nov 7,=
 2021 at 6:14 PM Nils &lt;<a href=3D"mailto:nils@nilsand.re">nils@nilsand.r=
e</a>&gt; wrote:<br></div><blockquote class=3D"gmail_quote" style=3D"margin=
:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"=
>---<br>
=C2=A0docs/batch.rst=C2=A0 =C2=A0 =C2=A0 =C2=A0| 10 +++++-----<br>
=C2=A0docs/dev_install.rst |=C2=A0 9 ++++-----<br>
=C2=A02 files changed, 9 insertions(+), 10 deletions(-)<br>
<br>
diff --git a/docs/batch.rst b/docs/batch.rst<br>
index 990f518d..c309d1fe 100644<br>
--- a/docs/batch.rst<br>
+++ b/docs/batch.rst<br>
@@ -12,11 +12,11 @@ All batch jobs are located in the directory tools/.<br>
<br>
=C2=A0docs/docload.py<br>
=C2=A0---------------<br>
-This script will load a new set of documentation. Simply specify the<br>
-version to load and point out the tarball to load from. The script<br>
-will automatically decompress the tarball as necessary, and also<br>
-perform HTML tidying of the documentation (since the HTML generated by<br>
-the PostgreSQL build system isn&#39;t particularly standards-conforming or=
<br>
+This script will load a new set of documentation. Simply specify the versi=
on to<br>
+load and the path to the tarball of the PostgreSQL source code to load fro=
m.<br>
+The script will automatically decompress the tarball as necessary, and als=
o<br>
+perform HTML tidying of the documentation (since the HTML generated by the=
<br>
+PostgreSQL build system isn&#39;t particularly standards-conforming or<br>
=C2=A0nice-looking).<br>
<br>
=C2=A0ftp/spider_ftp.py<br>
diff --git a/docs/dev_install.rst b/docs/dev_install.rst<br>
index b110efbb..9647e991 100644<br>
--- a/docs/dev_install.rst<br>
+++ b/docs/dev_install.rst<br>
@@ -34,9 +34,8 @@ with. Here&#39;s a quick step-by-step on how to do that:<=
br>
=C2=A0 =C2=A0 There are some parts of the site that require further setting=
s, but<br>
=C2=A0 =C2=A0 this should be enough to get the basics up and running.<br>
<br>
-#. In the pgweb directory run the following command to create all<br>
-=C2=A0 =C2=A0tables and indexes, as well as create a superuser for your lo=
cal<br>
-=C2=A0 =C2=A0installation::<br>
+#. Run the following command to create all tables and indexes, as well as<=
br>
+=C2=A0 =C2=A0create a superuser for your local installation::<br>
<br>
=C2=A0 =C2=A0 =C2=A0 =C2=A0 ./manage.py migrate<br>
<br>
@@ -51,11 +50,11 @@ with. Here&#39;s a quick step-by-step on how to do that=
:<br>
=C2=A0 =C2=A0 =C2=A0 =C2=A0 psql -d pgweb -f sql/varnish_local.sql<br>
<br>
=C2=A0#. To load some initial data for some tables (far from all at this<br=
>
-=C2=A0 =C2=A0point), in the pgweb directory, run the following command::<b=
r>
+=C2=A0 =C2=A0point), run the following command::<br>
<br>
=C2=A0 =C2=A0 =C2=A0 =C2=A0 pgweb/load_initial_data.sh<br>
<br>
-#. You&#39;ll want to creaet a superuser so you can access the `/admin/`<b=
r>
+#. You&#39;ll want to create a superuser so you can access the `/admin/`<b=
r>
=C2=A0 =C2=A0 interface::<br>
<br>
=C2=A0 =C2=A0 =C2=A0 =C2=A0 ./manage.py createsuperuser<br>
-- <br>
2.31.1<br>
<br>
<br>
<br>
</blockquote></div><div dir=3D"ltr" class=3D"gmail_signature"><div dir=3D"l=
tr"><br></div></div></div>

--0000000000001566b305d043ae1d--