Re: client auth docs seem to have devolved

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Magnus Hagander <magnus(at)hagander(dot)net>
Cc: Stephen Frost <sfrost(at)snowman(dot)net>, Dave Cramer <davecramer(at)gmail(dot)com>, Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>, PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: client auth docs seem to have devolved
Date: 2019-12-18 18:07:18
Message-ID: 10979.1576692438@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers pgsql-www

I wrote:
> Magnus Hagander <magnus(at)hagander(dot)net> writes:
>> This was changed by Peter in
>> commit 56811e57323faa453947eb82f007e323a952e1a1 along with the
>> restructuring. It used to say "the following subsections". So techically I
>> think that change is correct, but that doesn't necessarily make it helpful.
>> But based on how it actually renders, since that section doesn't contain
>> any actual useful info, we should perhaps just remove section 20.3
>> completely. Peter, thoughts?

> Then, URLs pointing to that page (such as Dave evidently has bookmarked)
> would break entirely, which doesn't seem like an improvement.

Also, our docs' own internal links to that section would break --- there
are built-in assumptions that there's one pointable-to place that explains
all the auth methods.

> I suggest changing the sect1's contents to be a list of available auth
> methods, linked to their subsections. That would provide approximately
> the same quality-of-use as the subsection TOC that used to be there.

Concretely, I propose the attached. Anybody want to editorialize on
my short descriptions of the auth methods?

regards, tom lane

Attachment Content-Type Size
provide-summary-of-auth-methods-1.patch text/x-diff 3.6 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2019-12-19 14:44:07 Re: client auth docs seem to have devolved
Previous Message Bruce Momjian 2019-12-18 03:27:33 Re: Example not producing shown output

Browse pgsql-hackers by date

  From Date Subject
Next Message Ranier Vf 2019-12-18 18:20:40 [PATCH] Windows port: add support to setenv function
Previous Message Fabrízio de Royes Mello 2019-12-18 18:06:58 Re: Restore backup file "with oids"

Browse pgsql-www by date

  From Date Subject
Next Message tsunakawa.takay@fujitsu.com 2019-12-19 07:28:14 "Resend" in mail archive does not recognize the change of email address
Previous Message Tom Lane 2019-12-17 20:42:34 Re: client auth docs seem to have devolved