From: Tom Lane <tgl@sss.pgh.pa.us>
To: Peter Eisentraut <peter_e@gmx.net>
Cc: pgsql-docs@postgresql.org
Subject: Re: Thoughts about the installation instructions
Date: Mon, 11 Mar 2002 21:20:34 -0500
Message-ID: <16357.1015899634@sss.pgh.pa.us> (raw)
In-Reply-To: <Pine.LNX.4.30.0203111632000.690-100000@peter.localdomain>
References: <Pine.LNX.4.30.0203111632000.690-100000@peter.localdomain>
Peter Eisentraut <peter_e@gmx.net> writes:
> It is my view that there should be a clean separation between installation
> and use documentation. First of all, it's really useless to put
> installation info into usage documentation because users see it too late.
This is too rigid a worldview.
The point of mentioning configuration issues in the usage docs is
that usage is when people will *find out* that they misconfigured
something. A link letting them know what they need to fix when they
observe some particular problem is not out of place in the usage docs.
I do agree that the installation procedures should mention all these
issues, too. Just don't strip out the references in the usage docs.
> Furthermore, remove the chapter(s) on installation from the Admin Guide
> and make then a document of their own. This document need only exist in
> the source tree and does not need to be installed.
Mumble. Certainly this could be a separate "book", but I strongly
disagree with removing it from the standard documentation set. To
my mind, the "integrated doc" *is* the standard documentation set and
should contain everything.
regards, tom lane
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: tgl@sss.pgh.pa.us, peter_e@gmx.net
Subject: Re: Thoughts about the installation instructions
In-Reply-To: <16357.1015899634@sss.pgh.pa.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox