Re: documentation structure - Mailing list pgsql-hackers

From David G. Johnston
Subject Re: documentation structure
Date
Msg-id CAKFQuwa0B0Levwh=iEgW+p33RL6zhSJ+_YazpQD9qhW6Vu_AVg@mail.gmail.com
Whole thread Raw
In response to Re: documentation structure  (Robert Haas <robertmhaas@gmail.com>)
Responses Re: documentation structure
List pgsql-hackers
On Fri, Mar 22, 2024 at 7:10 AM Robert Haas <robertmhaas@gmail.com> wrote:

That's actually what we had in chapter
18, "Installation from Source Code on Windows", since removed. But for
some reason we decided that on non-Windows platforms, it needed a
whole new chapter rather than an extra sentence in the existing one. I
think that's massively overkill.


I agree with the premise that we should have a single chapter, in the main documentation flow, named "Installation".  It should cover the architectural overview and point people to where they can find the stuff they need to install PostgreSQL in the various ways available to them.  I agree with moving the source installation material to the appendix.  None of the sections under Installation would then actually detail how to install the software since that isn't something the project itself handles but has delegated to packagers for the vast majority of cases and the source install details are in the appendix for the one "supported" mechanism that most people do not use.

David J.

pgsql-hackers by date:

Previous
From: Viliam Ďurina
Date:
Subject: Re: MIN/MAX functions for a record
Next
From: Tom Lane
Date:
Subject: Re: [PATCH] plpython function causes server panic