Skip site navigation (1) Skip section navigation (2)

Re: [HACKERS] Contrib modules documentation online

From: "Scott Marlowe" <scott(dot)marlowe(at)gmail(dot)com>
To: "Mario Gonzalez" <gonzalemario(at)gmail(dot)com>
Cc: "Neil Conway" <neilc(at)samurai(dot)com>, "Tom Lane" <tgl(at)sss(dot)pgh(dot)pa(dot)us>, "Josh Berkus" <josh(at)agliodbs(dot)com>, pgsql-hackers(at)postgresql(dot)org, "Albert Cervera i Areny" <albert(at)nan-tic(dot)com>, pgsql-docs(at)postgresql(dot)org
Subject: Re: [HACKERS] Contrib modules documentation online
Date: 2007-08-29 19:09:13
Message-ID: dcc563d10708291209w4ddbd0a3s44b8581ef4270f96@mail.gmail.com (view raw or flat)
Thread:
Lists: pgsql-docspgsql-hackers
On 8/29/07, Mario Gonzalez <gonzalemario(at)gmail(dot)com> wrote:
> On 29/08/2007, Neil Conway <neilc(at)samurai(dot)com> wrote:
> >
> > I wonder if it would be possible to keep the master version of the
> > contrib docs as SGML, and generate plaintext READMEs from it during the
> > documentation build.
> >
>
>   Hello Neil, I think I'm doing something similar but not with README
> files. Currently I'm writing the FAQ into Docbook XML, that's why we
> can build the HTML and plain text at one.

While I like the idea of the READMEs from contrib being in the docs, I
can't tell you the number of times I've installed a contrib module in
a dark ops center at 2am with no html browser handy (or at best a text
based one)  or with no access to external internet etc... and just
needed a line or two from the README file that came with the contrib
module.

Could the contrib README files couldn't be generated from the same
source as the docs (i.e. sgml) and then put into the appropriate
contrib/module/ directory.

In response to

Responses

pgsql-docs by date

Next:From: Michael GlaesemannDate: 2007-08-29 19:27:53
Subject: Re: [HACKERS] Contrib modules documentation online
Previous:From: Greg SmithDate: 2007-08-29 19:04:31
Subject: Re: Contrib modules documentation online

pgsql-hackers by date

Next:From: Tom LaneDate: 2007-08-29 19:20:29
Subject: Re: Advice on MyXactMade* flags, MyLastRecPtr, pendingDeletes and lazy XID assignment
Previous:From: Greg SmithDate: 2007-08-29 19:04:31
Subject: Re: Contrib modules documentation online

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group