Re: Documentation of server configuration

From: elein <elein(at)varlena(dot)com>
To: Josh Berkus <josh(at)agliodbs(dot)com>
Cc: Neil Conway <neilc(at)samurai(dot)com>, Simon Riggs <simon(at)2ndquadrant(dot)com>, Peter Eisentraut <peter_e(at)gmx(dot)net>, pgsql-docs(at)postgresql(dot)org
Subject: Re: Documentation of server configuration
Date: 2004-11-15 18:48:09
Message-ID: 20041115104809.A4604@cookie.varlena.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-general


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(at)varlena(dot)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
>

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Simon Riggs 2004-11-15 18:53:30 Re: Documentation of server configuration
Previous Message Josh Berkus 2004-11-15 18:16:53 Re: Documentation of server configuration

Browse pgsql-general by date

  From Date Subject
Next Message Simon Riggs 2004-11-15 18:53:30 Re: Documentation of server configuration
Previous Message Goutam Paruchuri 2004-11-15 18:24:42 Re: PostGreSQL to Access Updatable recordset