Re: client auth docs seem to have devolved

From: Magnus Hagander <magnus(at)hagander(dot)net>
To: Dave Cramer <davecramer(at)gmail(dot)com>, Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>, PostgreSQL WWW <pgsql-www(at)postgresql(dot)org>
Subject: Re: client auth docs seem to have devolved
Date: 2019-12-17 12:06:57
Message-ID: CABUevEzOcEBRLug3gTpAEhvSRjqyNLsk7QY70JbM-OStj=5cYA@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers pgsql-www

On Tue, Dec 17, 2019 at 1:02 PM Dave Cramer <davecramer(at)gmail(dot)com> wrote:

> On Tue, 17 Dec 2019 at 06:53, Magnus Hagander <magnus(at)hagander(dot)net> wrote:
>
>> On Tue, Dec 17, 2019 at 12:43 PM Dave Cramer <davecramer(at)gmail(dot)com>
>> wrote:
>>
>>> While following an old link to
>>> https://www.postgresql.org/docs/10/auth-methods.html
>>>
>>> I see a list of links to authentication methods. However:
>>>
>>> When I hit the current version
>>> https://www.postgresql.org/docs/current/auth-methods.html
>>>
>>> There are absolutely no links...
>>>
>>>
>> That's because the structure of the docs changed. You need to hit "up",
>> which will take you to
>> https://www.postgresql.org/docs/current/client-authentication.html,
>> which now has the list of links. Note how the different methods used to be
>> 20.3.x, and are now directly listed as 20.y.
>>
>> I'm unsure if that was intentional in the upstream docs, but that's what
>> makes the website behave like it does.
>>
>
> Fair enough but
>
> 20.3. Authentication Methods
> The following sections describe the authentication methods in more detail.
>
> certainly is misleading.
>
>
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?

--
Magnus Hagander
Me: https://www.hagander.net/ <http://www.hagander.net/>
Work: https://www.redpill-linpro.com/ <http://www.redpill-linpro.com/>

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2019-12-17 16:01:03 Re: client auth docs seem to have devolved
Previous Message Dave Cramer 2019-12-17 12:02:05 Re: client auth docs seem to have devolved

Browse pgsql-hackers by date

  From Date Subject
Next Message Amit Khandekar 2019-12-17 12:10:58 Re: logical decoding : exceeded maxAllocatedDescs for .spill files
Previous Message Dave Cramer 2019-12-17 12:02:05 Re: client auth docs seem to have devolved

Browse pgsql-www by date

  From Date Subject
Next Message Tom Lane 2019-12-17 16:01:03 Re: client auth docs seem to have devolved
Previous Message Dave Cramer 2019-12-17 12:02:05 Re: client auth docs seem to have devolved