Re: Status of doc/pgjdbc.xml

From: dmp <danap(at)ttc-cmc(dot)net>
To: Kris Jurka <books(at)ejurka(dot)com>, PostgreSQL JDBC <pgsql-jdbc(at)postgresql(dot)org>
Subject: Re: Status of doc/pgjdbc.xml
Date: 2015-04-10 15:14:51
Message-ID: 5527E8EB.3030409@ttc-cmc.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-jdbc

Kris Jurka wrote:
>
> What is the status the docbook documentation at doc/pgjdbc.xml? It seems
> that people are still updating it[1], but the documentation on the website
> comes from a completely different source[2] that is also being updated.
>
> Is there a point to keeping the docbook stuff if we're not going to put it
> on the website?
>
> How do we ensure developers also update the documentation in the separate
> www project?
>
> Kris Jurka
>
> 1) https://github.com/pgjdbc/pgjdbc/commits/master/doc/pgjdbc.xml
>
> 2) https://github.com/pgjdbc/www/commits/master/documentation/documentation.md
>

I have deleted most of the general notes on the webpage conversion to using
jekyll, but did keep a question.txt on the old web site. In there are two open
issues that were not addressed in the conversion.

* Documents/Changelog script make simpler to update/generate.
* Development/Todo script make simpler to update/generate.

The first as I recall, subject here, was that of getting docbook stuff to
convert to a jeckyll format, markup language. As the note indicates my intial
thoughts were some kinda of script. That was not carried through and a general
discussion might be still in the mail list to that effect.

This is something that I can not take on right now, and did not also then have
the time. I will consider reviewing again if deemed necessary though, but not
immediately.

danap.

In response to

Browse pgsql-jdbc by date

  From Date Subject
Next Message Gonzalo Ortiz Jaureguizar 2015-04-27 12:20:55 TIMESTAMP value binary transfer problem
Previous Message Kris Jurka 2015-04-10 08:59:21 Status of doc/pgjdbc.xml