public inbox for [email protected]  
help / color / mirror / Atom feed
From: elein <[email protected]>
To: Josh Berkus <[email protected]>
Cc: Neil Conway <[email protected]>
Cc: Simon Riggs <[email protected]>
Cc: Peter Eisentraut <[email protected]>
Cc: [email protected]
Subject: Re: Documentation of server configuration
Date: Mon, 15 Nov 2004 10:48:09 -0800
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>
	<[email protected]>
	<[email protected]>


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
[email protected]


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
> 



view thread (22+ messages)  latest in thread

reply

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: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Documentation of server configuration
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox