Re: Thoughts about the installation instructions - Mailing list pgsql-docs

From Tom Lane
Subject Re: Thoughts about the installation instructions
Date
Msg-id 16357.1015899634@sss.pgh.pa.us
Whole thread Raw
In response to Thoughts about the installation instructions  (Peter Eisentraut <peter_e@gmx.net>)
Responses Re: Thoughts about the installation instructions  (Peter Eisentraut <peter_e@gmx.net>)
List pgsql-docs
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

pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: Thoughts about the installation instructions
Next
From: Peter Eisentraut
Date:
Subject: Re: Thoughts about the installation instructions