Re: improve predefined roles documentation - Mailing list pgsql-hackers

From David G. Johnston
Subject Re: improve predefined roles documentation
Date
Msg-id CAKFQuwZiyeR08_jsHAvaWSCQ+tyf4sCwrBn_EX5xFYwhKX6Ycw@mail.gmail.com
Whole thread Raw
In response to improve predefined roles documentation  (Nathan Bossart <nathandbossart@gmail.com>)
Responses Re: improve predefined roles documentation
List pgsql-hackers
On Thu, Jun 13, 2024 at 12:48 PM Nathan Bossart <nathandbossart@gmail.com> wrote:
I think we could improve matters by abandoning the table and instead
documenting these roles more like we document GUCs, i.e., each one has a
section below it where we can document it in as much detail as we want.


One of the main attributes for the GUCs is their category.  If we want to improve organization we'd need to assign categories first.  We already implicitly do so in the description section where we do group them together and explain why - but it is all informal.  But getting rid of those groupings and descriptions and isolating each role so it can be linked to more easily seems like a net loss in usability.

I'm against getting rid of the table.  If we do add authoritative subsection anchors we should just do like we do in System Catalogs and make the existing table name values hyperlinks to those newly added anchors.  Breaking the one table up into multiple tables along category lines is something to consider.

David J.

pgsql-hackers by date:

Previous
From: Robert Haas
Date:
Subject: Re: RFC: adding pytest as a supported test framework
Next
From: Andrew Dunstan
Date:
Subject: Re: RFC: adding pytest as a supported test framework