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

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

From: David Fetter <david(at)fetter(dot)org>
To: Magnus Hagander <magnus(at)hagander(dot)net>
Cc: Alvaro Herrera <alvherre(at)commandprompt(dot)com>, nikolay(at)samokhvalov(dot)com,pgsql-www(at)postgresql(dot)org,PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: [DOCS] Users comments don't migrate to docs fornew version?
Date: 2007-06-07 17:06:51
Message-ID: 20070607170651.GA3116@fetter.org (view raw or flat)
Thread:
Lists: pgsql-docspgsql-www
On Wed, Jun 06, 2007 at 09:18:29PM +0200, Magnus Hagander wrote:
> Alvaro Herrera wrote:
> > Nikolay Samokhvalov wrote:
> >> I've just found (via google...) useful (for me) comments:
> >> http://www.postgresql.org/docs/8.0/interactive/sql-createaggregate.html
> >> -- I mean users comments under primary contents of the page.
> >>
> >> These comments were written for 8.0, but are useful for the
> >> current versions too.  What we have is the situation that reading
> >> docs for 8.2 people don't see these comments -- so this
> >> potentially useful information is lost.  So, in this
> >> implementation the idea of comments for docs becomes weak in
> >> general.
> > 
> > The thing to do in these cases is to move the useful info from the
> > user comments into the main doc text.
> 
> Yeah, that's the idea.  Tom often goes through the comments and puts
> stuff into the docs.  But I'm sure there are a *lot* of other people
> who could help with that as well - read comments, figure out of they
> make sense, and submit a docs patch for the next version!

It occurs to me that we could encourage this by emphasizing on the
interactive docs that user comments are not carried forward
automatically and pointing to a place where people can learn how to
submit such patches if they so desire.

Here is the wording I'd propose to replace the paragraph after "Add Comment":

Please use this form to add your own comments regarding your
experience with particular features of PostgreSQL, clarifications of
the documentation, or hints for other users.  These comments are
not automatically carried into future versions of the documentation.
If you believe your change should carry forward, please consider <a
href="http://www.postgresql.org/docs/current/static/docguide.html">patching
the document source SGML</a> and sending those patches to <a
href="mailto:pgsql-docs(at)postgresql(dot)org">psql-docs</a> for inclusion in
the official documentation.  This is a way to participate more in the
PostgreSQL project.

This is not a support forum, and your IP address will be logged.  If
you have a question or need help, please see the <a
href=http://www.postgresql.org/docs/faq/>FAQ</a>, try a mailing <a
href="http://www.postgresql.org/community/lists/">list</a>, or join us
on <a irc://irc.freenode.net/postgresql>IRC</a>.

Submissions containing URLs or other keywords commonly found in spam
comments may be silently discarded.  Please contact the <a
href="mailto:webmaster(at)postgresql(dot)org">webmaster</a> if you think this
is happening to you in error.

Cheers,
David.
-- 
David Fetter <david(at)fetter(dot)org> http://fetter.org/
phone: +1 415 235 3778        AIM: dfetter666
                              Skype: davidfetter

Remember to vote!
Consider donating to PostgreSQL: http://www.postgresql.org/about/donate

In response to

pgsql-docs by date

Next:From: Nikolay SamokhvalovDate: 2007-06-07 21:18:58
Subject: Re: [DOCS] Users comments don't migrate to docs for new version?
Previous:From: Tom LaneDate: 2007-06-07 14:51:38
Subject: Re: Probably mistake in Arrays docs & proposal for index

pgsql-www by date

Next:From: Nikolay SamokhvalovDate: 2007-06-07 21:18:58
Subject: Re: [DOCS] Users comments don't migrate to docs for new version?
Previous:From: Simon RiggsDate: 2007-06-07 10:31:00
Subject: Request for minor link changes

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