Re: doc: add missing "id" attributes to extension packaging page

Brar Piening <brar@gmx.de>

From: Brar Piening <brar@gmx.de>

To: Alvaro Herrera <alvherre@alvh.no-ip.org>, "Karl O. Pinc" <kop@karlpinc.com>

Cc: Peter Eisentraut <peter.eisentraut@enterprisedb.com>, Tom Lane <tgl@sss.pgh.pa.us>, vignesh C <vignesh21@gmail.com>, Ian Lawrence Barwick <barwick@gmail.com>, pgsql-hackers <pgsql-hackers@postgresql.org>

Date: 2023-03-23T19:08:52Z

Lists: pgsql-hackers

Attachments

001-add-needed-ids_v2.postgresql.patch (text/plain) patch v2
002-make_html_ids_discoverable_v4.postgresql.patch (text/plain) patch v4
003-add-discoverable-id-style_v1.pgweb.patch (text/plain) patch v1

On 23.03.2023 at 10:35, Alvaro Herrera wrote:
> As with the <simplelist> patch, we'll need to patch the CSS used in the
> website for the docs too, as that's the most important place where docs
> are visited.

Ok, I've created and tested a patch for this too.

Since the need for ids is starting to grow again (ecb696527c added an id
to a varlistentry in doc/src/sgml/ref/create_subscription.sgml) I've
also amended the add-needed-ids patch once again so that the build does
not fail after applying the make_html_ids_discoverable patch.

I've also attached the (unchanged)  make_html_ids_discoverable patch for
convenience so this email now contains two patches for postgresql
(ending with .postgresql.patch) and one patch for pgweb (ending with
.pgweb.patch).

TBH I'm a bit afraid that people will immediately start complaining
about the failing docs builds after this got applied since it forces
them to add ids to all varlistenries in a variablelist if they add one,
which can be perceived as quite a burden (also committers and reviewers
will have to get used to always watch out for failing docs builds
because of this).

Since breaking the build on missing ids was an intentional decision we
can theoretically soften this by only issuing a warning or removing the
check for missing id's altogether but this would probably defeat the
purpose since it would lead to an increasing number of entries that lack
an id after a while.

Regards,

Brar

Commits

doc: Make HTML ids discoverable
- e2922702a302 16.0 landed
Add missing XML ID attribute
- a34901dd03ed 16.0 landed
postgres_fdw: Add support for parallel abort.
- 983ec23007bd 16.0 cited
Add missing XML ID attributes
- 3077324b03e8 16.0 landed
Add XML ID attributes to create_subscription.sgml.
- de5a47af2d80 16.0 cited
Stop recommending auto-download of DTD files, and indeed disable it.
- 969509c3f2e3 16.0 cited
Doc: add XML ID attributes to <sectN> and <varlistentry> tags.
- 78ee60ed84bb 16.0 landed
Allow left join removals and unique joins on partitioned tables
- 3c569049b7b5 16.0 cited
Improve GIN cost estimation
- cd9479af2af2 16.0 cited