Re: [PATCHES] Replication Documentation

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: Alvaro Herrera <alvherre(at)commandprompt(dot)com>
Cc: pgsql-hackers(at)postgresql(dot)org, Chris Browne <cbbrowne(at)acm(dot)org>
Subject: Re: [PATCHES] Replication Documentation
Date: 2006-08-02 02:27:25
Message-ID: 200608020427.26195.peter_e@gmx.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers pgsql-patches

Alvaro Herrera wrote:
> > >I don't think this sort of material belongs directly into the
> > > PostgreSQL documentation.
>
> Why not?

PostgreSQL documentation (or any product documentation) should be
factual: describe what the software does and give advice on its use.
This should be mostly independent of the external circumstances,
because people will still read that documentation three or four years
from now.

The proposed text is, at least partially, journalistic: it evaluates
competing ideas, gives historical and anecdotal information, reports on
current events, and makes speculations about the future. That is the
sort of material that is published in periodicals or other volatile
media.

At the summit, we resolved, for precisely these reasons, to keep the
journalistic parts on the web site, for clear separation from the
shipped product and for easier updates (and for easier reference as
well, because the PostgreSQL documentation is not the single obvious
place to look for it) and refer to it from the documentation.

--
Peter Eisentraut
http://developer.postgresql.org/~petere/

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Christopher Browne 2006-08-02 02:27:33 Re: Replication Documentation
Previous Message Michael Fuhr 2006-08-02 02:24:03 tg_trigtuple/tg_newtuple settings in AFTER triggers

Browse pgsql-patches by date

  From Date Subject
Next Message Christopher Browne 2006-08-02 02:27:33 Re: Replication Documentation
Previous Message Michael Fuhr 2006-08-02 02:24:03 tg_trigtuple/tg_newtuple settings in AFTER triggers