Re: [HACKERS] Small issue in online devel documentation build

On Sat, Feb 18, 2017 at 1:45 AM, Peter Eisentraut <
peter(dot)eisentraut(at)2ndquadrant(dot)com> wrote:

> On 2/16/17 15:35, Fabien COELHO wrote:
> > After some random digging, it seems that the documentation files are
> > loaded from provided tarballs by a script: "tools/docs/docload.py"
> > maintained in "pgweb.git". Maybe this is run from some cron.
> >
> > AFAICS from the script, the provided tarballs contains the generated html
> > that someone/something has already generated and put somewhere. I have
> > found no clear clue about who, where and when. However I would bet that
> > "Magnus Hagander" and "Dave Page" know, given that they commits suggest
> > that they are maintaining the site:-)
> >
> > The load script passes the doc through "tidy" with some options, and
> > registers the pages into a database probably for django. I doubt this
> > would change the ul class.
>
> Can someone from the web site team look into this?
>

Sure.

The script in question loads the docs from the build tarballs - we read
whatever goes in the snapshot tarballs on the site and load that in the db.

The developer docs, and the snapshot tarballs, run as a final step of the
buildfarm job on guaibasaurus.

The toolchain used previously (9.6) generates this code:
<P
> Protocol to use for submitting queries to the server:
<P
></P
></P><UL
><LI
><P
><TT
CLASS="LITERAL"
>simple</TT
>: use simple query protocol.</P
></LI
><LI
><P
><TT
CLASS="LITERAL"
>extended</TT
>: use extended query protocol.</P
></LI
><LI
><P
><TT
CLASS="LITERAL"
>prepared</TT
>: use extended query protocol with prepared statements.</P
></LI
></UL

(yes, including all the horrible newlines in the middle of tags and
whatnot, but there's nothing new about that)

The toolchain used for dev (10) generates this code:
<p> Protocol to use for submitting queries to the server:
</p><div class="itemizedlist"><ul class="itemizedlist"
style="list-style-type: disc; "><li class="listitem"><p><code
class="literal">simple</code>: use simple query protocol.</p></li><li
class="listitem"><p><code class="literal">extended</code>: use extended
query protocol.</p></li>

So the HTML generated is completely different. The old one didn't even use
unnumbered lists.

Is that intentional?

I for one did not realize the new toolchain created completely different
structure HTML. I know we applied a41a4cc74be8c34f7f8f1c4ec03b5dc01db06c17
to handle changes from the new toolchain, but that won't cover cases where
the whole structure is different.

In this particular case, the boldness comes from the c2 class as indicated
earlier. But that class has always been bold.

Might it just be that somebody has to actually go over the new structure of
the docs and provide the appropriate CSS rules? Or is something wrong with
the actual building of them as they give a completely different structure?

As for the reproduction - the snapshot tarballs are built by the buildfarm
animal guaibasaurus, which is on Debian Jessie. Could the inability to
reproduce be because of platform differences in the docs tools?

--
Magnus Hagander
Me: http://www.hagander.net/
Work: http://www.redpill-linpro.com/