Re: Make pgoutput documentation easier to find

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Make pgoutput documentation easier to find
Date: 2025-08-06 11:36:21
Message-ID: 900b7421-1f32-47c7-9ad2-4144dfd7b679@eisentraut.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 03.08.25 03:32, Fujii Masao wrote:
> The current documentation for pgoutput is buried in the logical streaming
> replication protocol section (in protocol.sgml), and there's no index entry
> for it. This makes it hard to discover and access, for example, when trying
> to look up the options it supports.
>
> I've often struggled to locate this information myself, so I'd like to
> propose moving the pgoutput documentation to the logical decoding section
> and adding an index entry. The attached patch does that. I think this change
> will make it much easier for users to find the relevant details.

This would move the documentation of pgoutput from "Internals" to
"Server Programming". So it's a question of whether this is something
we want to advertise that people can use directly. In the past,
pgoutput was an implementation detail of logical replication. But I
gather people are using it for other things now? Still not clear what
kind of guarantees we want to give about its interfaces, for example.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Eisentraut 2025-08-06 11:44:25 Re: Initcap works differently with different locale providers
Previous Message Oleg Tselebrovskiy 2025-08-05 09:01:02 Re: Initcap works differently with different locale providers