Re: Interactive docs idea - Mailing list pgsql-hackers

From Robert Treat
Subject Re: Interactive docs idea
Date
Msg-id 1113494098.26133.440.camel@camel
Whole thread Raw
In response to Re: Interactive docs idea  ("Dave Page" <dpage@vale-housing.co.uk>)
Responses Re: Interactive docs idea
List pgsql-hackers
On Thu, 2005-04-14 at 03:56, Dave Page wrote:
>  
> 
> > -----Original Message-----
> > From: pgsql-hackers-owner@postgresql.org 
> > [mailto:pgsql-hackers-owner@postgresql.org] On Behalf Of Greg Stark
> > Sent: 14 April 2005 04:54
> > To: pgsql-hackers@postgresql.org
> > Subject: Re: [HACKERS] Interactive docs idea
> > 
> > Alvaro Herrera <alvherre@dcc.uchile.cl> writes:
> > 
> > > I think it's an interesting idea to mail the comments to 
> > pgsql-docs, but
> > > *please don't* start emulating the PHP behavior regarding comments
> > > (leaving the "relevant" ones forever) :-(  I think the PHP 
> > manuals are
> > > very low quality because of the information in comments which really
> > > belongs in the main text body (which is crappy in PHP's 
> > manual anyway
> > > IMHO.)
> > 
> > It seems that's not much of a danger -- the interactive 
> > Postgres documentation
> > hardly gets any comments at all in the first place. It would be a big
> > improvement if there were some way to encourage many more comments.
> 
> We can get from 2 - 10 a day I would guess. They get mailed to a closed
> list for moderation.
> 

It's not so much closed as just separate and this was mainly because the
folks on -docs and the folks on -www didn't want all the traffic.  

FWIW the PHP docs do actually integrate their comments into the docs,
although this seems to have slowed down much more over the recent years.
(I know they used to do it though, cause several comments I put in 5+
years ago have been integrated into the mainline docs).  

On the PostgreSQL front, Tom has in the past gone through comments
around release time and integrated in the relevant changes; I've also
submitted a patch or two based on suggestions that have come across
since we got the new system in place. If you're interested in moderating
the comments and have time to write patches for new suggestions I'm sure
most people would be happy to have you on board.


Robert Treat
-- 
Build A Brighter Lamp :: Linux Apache {middleware} PostgreSQL



pgsql-hackers by date:

Previous
From: Tom Lane
Date:
Subject: Re: Constant time insertion into highly non-unique indexes
Next
From: Simon Riggs
Date:
Subject: Re: Constant time insertion into highly non-unique