Date: Mon, 15 Nov 2004 10:48:09 -0800
From: elein <elein@varlena.com>
To: Josh Berkus <josh@agliodbs.com>
Cc: Neil Conway <neilc@samurai.com>, Simon Riggs <simon@2ndquadrant.com>,
	Peter Eisentraut <peter_e@gmx.net>, pgsql-docs@postgresql.org
Subject: Re: Documentation of server configuration
Message-ID: <20041115104809.A4604@cookie.varlena.com>
Mail-Followup-To: Josh Berkus <josh@agliodbs.com>,
	Neil Conway <neilc@samurai.com>, Simon Riggs <simon@2ndquadrant.com>,
	Peter Eisentraut <peter_e@gmx.net>, pgsql-docs@postgresql.org
References: <200411132120.51294.peter_e@gmx.net>
	<1100449519.2950.1123.camel@localhost.localdomain>
	<1100493852.23420.33.camel@localhost.localdomain>
	<200411151016.53648.josh@agliodbs.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <200411151016.53648.josh@agliodbs.com>
User-Agent: Mutt/1.3.22.1i


As a header to the Config section, a hypertext index in alphabetical
order is what I suggested before.  It takes less space and
enables one to read it by section or to jump to where the
particular GUC is documented. 

I think the alpha index would be easier and more helpful
to people doing fast lookups like Peter was looking for
and lets the chapters stay in the nicely grouped format.

--elein
elein@varlena.com


On Mon, Nov 15, 2004 at 10:16:53AM -0800, Josh Berkus wrote:
> Neil,
> 
> > I agree that this section is frequently accessed. Given that, I think it
> > is somewhat difficult to find -- we've all memorized that it is in the
> > "Server Run-time Environment" chapter, but I don't think that's the
> > first place most people would look. What do people think about
> > separating the configuration section out to be a new top-level chapter?
> 
> I'd be up for that.   The trick will be getting it done before 8.0 ... 
> although if we're going into another beta, maybe time isn't precious yet.
> 
> Actually, what I'd see is:
> 
> 1) a section explaining the most frequently modified options, and links;
> 2) a section grouping options by general purpose (like our current 
> categories), with links;
> 3) a dictionary of config options, which personally I would prefer to be one 
> per page like the SQL commands.
> 
> If we were to do the above, then re-ordering the "dictionary" to pure 
> alphabetical would make perfect sense.
> 
> -- 
> Josh Berkus
> Aglio Database Solutions
> San Francisco
> 
> ---------------------------(end of broadcast)---------------------------
> TIP 7: don't forget to increase your free space map settings
>