Re: [PATCHES] Replication Documentation - Mailing list pgsql-hackers

From Peter Eisentraut
Subject Re: [PATCHES] Replication Documentation
Date
Msg-id 200608020427.26195.peter_e@gmx.net
Whole thread Raw
In response to Re: [PATCHES] Replication Documentation  (Alvaro Herrera <alvherre@commandprompt.com>)
Responses Re: [PATCHES] Replication Documentation
Re: Replication Documentation
List pgsql-hackers
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/


pgsql-hackers by date:

Previous
From: Rod Taylor
Date:
Subject: Re: GENERATED ... AS IDENTITY, Was: Re: Feature Freeze
Next
From: Tom Lane
Date:
Subject: Re: Values list-of-targetlists patch for comments (was Re: [PATCHES] 8.2 features?)