Re: [HACKERS] Contrib modules documentation online

From: Josh Berkus <josh(at)agliodbs(dot)com>
To: pgsql-hackers(at)postgresql(dot)org
Cc: 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 17:09:07
Message-ID: 200708291009.07942.josh@agliodbs.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

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.

--
Josh Berkus
PostgreSQL @ Sun
San Francisco

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Decibel! 2007-08-29 17:43:39 Re: [HACKERS] Contrib modules documentation online
Previous Message Nikolay Samokhvalov 2007-08-29 08:35:22 Re: Contrib modules documentation online

Browse pgsql-hackers by date

  From Date Subject
Next Message Florian G. Pflug 2007-08-29 17:32:00 Advice on MyXactMade* flags, MyLastRecPtr, pendingDeletes and lazy XID assignment
Previous Message Tom Lane 2007-08-29 16:44:39 Re: correct behavior of ANALYZE ...