Thread: Re: DOCS: pg_createsubscriber wrong link?

Re: DOCS: pg_createsubscriber wrong link?

From
vignesh C
Date:
On Fri, 13 Dec 2024 at 10:58, Peter Smith <smithpb2250@gmail.com> wrote:
>
> Hi,
>
> While reviewing the pg_createsubscriber [1] docs I found a potentially
> wrong linkend.
>
> This sentence:
> "For smaller databases, initial data synchronization is recommended."
>
> links to [2] ("29.4.5. Initial Data Synchronization").
>
> This seems to have been deliberately changed (commit [3])
>
> FROM: <link linkend="logical-replication">initial data synchronization</link>
>
> TO: <link linkend="logical-replication-row-filter-initial-data-sync">initial
> data synchronization</link>
>
> Although the title "Initial Data Synchronization" seems at face value
> to be relevant, this particular link target is a sub-section of "Row
> Filters", so I don't see why this would be the intended link from the
> pg_createsubscriber. AFAICT, the original discussion and commit
> message does not explain.

I also felt that the link was directed to the wrong page.

> Here is a new patch giving an alternate link which IMO might be more
> appropriate.

How about we change the below:
    more the time when the logical replica will be available. For smaller
-   databases, <link linkend="logical-replication-row-filter-initial-data-sync">
-   initial data synchronization</link> is recommended.
+   databases, initial data synchronization is recommended. For details, see the
+   <command>CREATE SUBSCRIPTION</command> <link
linkend="sql-createsubscription-params-with-copy-data">
+   <literal>copy_data</literal></link> option.
+
to:
For smaller databases, it is recommended to set up <link
linkend="logical-replication">logical replication</link> with <link
linkend="sql-createsubscription-params-with-copy-data">initial data
synchronization</link>.

Regards,
Vignesh



Re: DOCS: pg_createsubscriber wrong link?

From
vignesh C
Date:
On Mon, 16 Dec 2024 at 02:53, Peter Smith <smithpb2250@gmail.com> wrote:
>
> On Fri, Dec 13, 2024 at 8:31 PM vignesh C <vignesh21@gmail.com> wrote:
> >
> > On Fri, 13 Dec 2024 at 10:58, Peter Smith <smithpb2250@gmail.com> wrote:
> > >
> > > Hi,
> > >
> > > While reviewing the pg_createsubscriber [1] docs I found a potentially
> > > wrong linkend.
> > >
> > > This sentence:
> > > "For smaller databases, initial data synchronization is recommended."
> > >
> > > links to [2] ("29.4.5. Initial Data Synchronization").
> > >
> > > This seems to have been deliberately changed (commit [3])
> > >
> > > FROM: <link linkend="logical-replication">initial data synchronization</link>
> > >
> > > TO: <link linkend="logical-replication-row-filter-initial-data-sync">initial
> > > data synchronization</link>
> > >
> > > Although the title "Initial Data Synchronization" seems at face value
> > > to be relevant, this particular link target is a sub-section of "Row
> > > Filters", so I don't see why this would be the intended link from the
> > > pg_createsubscriber. AFAICT, the original discussion and commit
> > > message does not explain.
> >
> > I also felt that the link was directed to the wrong page.
> >
>
> Thanks.
>
> > > Here is a new patch giving an alternate link which IMO might be more
> > > appropriate.
> >
> > How about we change the below:
> >     more the time when the logical replica will be available. For smaller
> > -   databases, <link linkend="logical-replication-row-filter-initial-data-sync">
> > -   initial data synchronization</link> is recommended.
> > +   databases, initial data synchronization is recommended. For details, see the
> > +   <command>CREATE SUBSCRIPTION</command> <link
> > linkend="sql-createsubscription-params-with-copy-data">
> > +   <literal>copy_data</literal></link> option.
> > +
> > to:
> > For smaller databases, it is recommended to set up <link
> > linkend="logical-replication">logical replication</link> with <link
> > linkend="sql-createsubscription-params-with-copy-data">initial data
> > synchronization</link>.
> >
>
> Hi Vignesh.
>
> I took parts of your suggestion:
>
> - I changed the 1st sentence's wording as suggested.
> - I included a "logical replication" link as suggested, but I put it
> earlier, where it was first mentioned on this page.
> - I kept my 2nd sentence with the "copy_data" link as-is. That's
> because if this docs page was in hardcopy format, doing it your way
> the reader would have no clue about the link target.
>
> Please see patch v2.

Thanks for the updated version. The v2 version patch looks great and
applies cleanly to both the HEAD and PG17 branches.

Regards,
Vignesh