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

Re: [DOCS] Users comments don't migrate to docs for new version?

From: Kevin Hunter <hunteke(at)earlham(dot)edu>
To: Nikolay Samokhvalov <nikolay(at)samokhvalov(dot)com>
Cc: Magnus Hagander <magnus(at)hagander(dot)net>, Alvaro Herrera <alvherre(at)commandprompt(dot)com>, PostgreSQL WWW List <pgsql-www(at)postgresql(dot)org>, PostgreSQL Documentation List <pgsql-docs(at)postgresql(dot)org>
Subject: Re: [DOCS] Users comments don't migrate to docs for new version?
Date: 2007-06-08 11:56:33
Message-ID: FDBCCA0A-3194-4F35-B160-0E839D80ADC0@earlham.edu (view raw or flat)
Thread:
Lists: pgsql-docspgsql-www
At 5:18p -0400 on 07 Jun 2007, Nikolay Samokhvalov wrote:

> But I suppose there are some cases when it's not possible to move the
> comment to the main text -- e.g. if the comment concerns too narrow
> area, is very specific and is useful not for all people (but still
> useful for some!).
>
> Moreover, moving good comments to the main text makes the text bloated
> -- what if we have 10 examples of using function aaa() and all of them
> are illustrations for different areas? We (ok, sorry, Tom because only
> he knows English) will choose only 1 of them to avoid bloating of the
> main text, even if all 10 use cases has some specific features...

Hrm.  If they're still good comments, what about including a  
hyperlink to a pop-up or separate page with some specific information  
about that particular point?  ("There is more <a  
href='popup'>discussion on the many uses of the function aaa()</a>")   
Bloat for the main documentation could still avoided, but if read on- 
line (as the docs are meant to be read?) then access to other's  
wisdom need not lost/weeded out.

> I could help with (yeah, not with reworking comments -- I do not know
> English well :-) ) creating a simple patch that adds a notice "this
> comment was originally created for version 8.0" and maybe something

Although, short of above, perhaps this'd be an easier en masse solution?

> BTW, then we would add some marking/rating system to the comments  
> to allow other users see what comment is really useful.

Kind of like digg or something?  Where the higher-rated float to the  
top?

Kevin

In response to

Responses

pgsql-docs by date

Next:From: Oleg BartunovDate: 2007-06-08 12:41:48
Subject: Re: [DOCS] Users comments don't migrate to docs for new version?
Previous:From: Andrej Ricnik-BayDate: 2007-06-07 23:24:09
Subject: Re: [pgsql-www] Users comments don't migrate to docs for new version?

pgsql-www by date

Next:From: Oleg BartunovDate: 2007-06-08 12:41:48
Subject: Re: [DOCS] Users comments don't migrate to docs for new version?
Previous:From: Patrick TJ McPheeDate: 2007-06-08 04:13:54
Subject: Re: index vs. seq scan choice?

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