Uploaded image for project: 'Debezium'
  1. Debezium
  2. DBZ-3858

Improperly constructed links generating downstream build errors

XMLWordPrintable

      In the documentation, a ModuleID declaration in the upstream sources is typically used to define a downstream-specific anchor ID to correspond to an existing upstream ID. Due to these distinct IDs, cross-reference links that are used in both the upstream and downstream documentation often target different anchors.
      When a link uses the simple xref:<anchor_id>[link_text] format, the script that fetches upstream files for use downstream is unable to convert the ID, resulting in an error of the type The following Unknown ID xxx used as an internal cross reference.

      To enable the fetch script to convert IDs in a link, the link must use the following format:
      {link-prefix}:{link-<link-attribute-shared-upstream-and-downstream>}#<anchorID>[<Link_text>].

      Links that include the following IDs on the specified file:line require reformatting:

      postgresql-permissions postgresql.adoc:117 DONE
      postgresql-security postgresql.adoc:1959 (1981 on master) DONE

      mongodb-snapshot-metrics mongodb.adoc:1409 DONE
      mongodb-streaming-metrics mongodb.adoc:1410 DONE

      offline-schema-updates sqlserver.adoc:2298: (2311 on master) DONE
      online-schema-updates sqlserver.adoc:2299 (2312 on master) DONE
      sqlserver-snapshot-metrics sqlserver.adoc:2461 (2474) DONE
      sqlserver-streaming-metrics sqlserver.adoc:2462 (2475) DONE
      sqlserver-schema-history-metrics sqlserver.adoc:2463 (2476) DONE

      example-basic-content-based-routing-configuration content-based-routing.adoc:178 DONE

      topic-creation-groups topic-auto-create-config.adoc:86 DONE
      topic-creation-group-configuration-properties topic-auto-create-config.adoc:87 DONE

      options-for-applying-the-transformation-selectively outbox-event-router.adoc:24 DONE

              broldan@redhat.com Robert Roldan
              broldan@redhat.com Robert Roldan
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: