From: Scott Marlowe <scott.marlowe@gmail.com>
To: Mario Gonzalez <gonzalemario@gmail.com>
Cc: Neil Conway <neilc@samurai.com>
Cc: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Josh Berkus <josh@agliodbs.com>
Cc: pgsql-hackers@postgresql.org, "Albert Cervera i Areny" <albert@nan-tic.com>
Cc: pgsql-docs@postgresql.org
Subject: Re: [HACKERS] Contrib modules documentation online
Date: Wed, 29 Aug 2007 14:09:13 -0500
Message-ID: <dcc563d10708291209w4ddbd0a3s44b8581ef4270f96@mail.gmail.com> (raw)
In-Reply-To: <2065a6cf0708291127j3b0ee41bp1ca5b9391935af67@mail.gmail.com>
References: <200708290157.07968.albert@nan-tic.com>
<200708291009.07942.josh@agliodbs.com>
<7046.1188410001@sss.pgh.pa.us>
<1188411524.32003.6.camel@dell.linuxdev.us.dell.com>
<2065a6cf0708291127j3b0ee41bp1ca5b9391935af67@mail.gmail.com>
On 8/29/07, Mario Gonzalez <gonzalemario@gmail.com> wrote:
> On 29/08/2007, Neil Conway <neilc@samurai.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.
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: scott.marlowe@gmail.com, gonzalemario@gmail.com, neilc@samurai.com, tgl@sss.pgh.pa.us, josh@agliodbs.com, albert@nan-tic.com
Subject: Re: [HACKERS] Contrib modules documentation online
In-Reply-To: <dcc563d10708291209w4ddbd0a3s44b8581ef4270f96@mail.gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox