From: Decibel! <decibel@decibel.org>
To: 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 12:43:39 -0500
Message-ID: <20070829174339.GJ1386@nasby.net> (raw)
In-Reply-To: <200708291009.07942.josh@agliodbs.com>
References: <200708290157.07968.albert@nan-tic.com>
<200708291009.07942.josh@agliodbs.com>
On Wed, Aug 29, 2007 at 10:09:07AM -0700, Josh Berkus wrote:
> Albert,
>
> (crossed over to -docs, where it really belongs)
>
> > I've been working on converting the current README files for all contrib
> > modules into sgml and add it to the documentation. There are still some
> > fixes to do but i'd like to have some feedback. Indeed, it wasn't agreed to
> > have all if any of the modules together with the core documentation.
> >
> > You can see the docs on [1] in chapter VIII. If you think these could be a
> > good addition, please fill free to comment on how you think sections should
> > be organized to be consistent and easy to read.
> >
> > [1] http://www.nan-tic.com/ftp/pgdoc
>
> Wow, this is really, really cool! You're my hero.
>
> I'm very strongly in favor of having this documentation. However, I think it
> might make sense to put "Contrib Modules" as a section under either
> "Reference" or "Appendices". Also, I don't think it's necessary to make each
> command option a separate subchapter, but I can see how that would be hard to
> avoid in an automated system.
>
> Guys, would it be out of the question to do this in 8.3? Please please?
>
> If we go ahead with this, I'll commit to doing a contrib README cleanup so the
> doc system works better.
One question... would there still be a README in each contrib directory?
I think getting this stuff in the docs is great, but the README in the
source is also very valuable and I'd hate to lose it.
--
Decibel!, aka Jim Nasby decibel@decibel.org
EnterpriseDB http://enterprisedb.com 512.569.9461 (cell)
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: decibel@decibel.org, josh@agliodbs.com, albert@nan-tic.com
Subject: Re: [HACKERS] Contrib modules documentation online
In-Reply-To: <20070829174339.GJ1386@nasby.net>
* 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