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

Re: Thoughts about the installation instructions

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Peter Eisentraut <peter_e(at)gmx(dot)net>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: Thoughts about the installation instructions
Date: 2002-03-12 02:20:34
Message-ID: 16357.1015899634@sss.pgh.pa.us (view raw or flat)
Thread:
Lists: pgsql-docs
Peter Eisentraut <peter_e(at)gmx(dot)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

In response to

Responses

pgsql-docs by date

Next:From: Peter EisentrautDate: 2002-03-12 17:40:53
Subject: Re: Thoughts about the installation instructions
Previous:From: Bruce MomjianDate: 2002-03-11 22:16:08
Subject: Re: Thoughts about the installation instructions

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