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

Connector doc formatting and link fixes

    XMLWordPrintable

Details

    Description

      In reviewing the build for the Q1 downstream doc, I discovered a few minor errors that need fixing. These are mostly repeated instances of the same error.

      • Anchor IDs that are omitted from some links work ok upstream, but downstream, they result in a generic link to the top-level of the User Guide.
      • For each connector, the introductory Deployment section that's conditionalized for downstream use, includes a bullet in which a list continuation character (+) is placed on separate line, resulting in excess space between the bullet item and the following text. Replace the newline with a space, so that the character is appended to the line for the bullet item.

      To expedite corrections to the Q1 release doc, a separate downstream-only fix that fixes most of the errors is already applied to the relevant files.

      The following edits are needed in the upstream files:

      • architecture.adoc
        • L33: link to topic routing missing anchor ID: #topic-routing
        • L39: Link to new record state extraction missing anchor ID #new-record-state-extraction
      • db2.adoc
        • L880: Anchor omitted in links to Avro converter and serialization docs: #avro-serialization
        • L895: Anchor omitted in links to Avro serialization docs: #avro-serialization
        • L1628: List continuation
        • L1851: Anchor omitted in links to Avro converter and serialization docs: #avro-serialization
      • mongodb.adoc
        • L739: Anchor omitted in links to Avro converter and serialization docs: #avro-serialization
        • L1073: List continuation
      • mysql.adoc
        • L1080 Anchor omitted in links to Avro converter and serialization docs: #avro-serialization
        • L1095 Anchor omitted in links to Avro converter and serialization docs: #avro-serialization
        • L2014 List continuation
        • L2798 Anchor omitted in links to Avro serialization doc: #avro-serialization
      • oracle.adoc
        • L902 Link to Avro Converter targets /docs/faq. Replace with attribute that links to docs/configuration/avro/? Also typo: schems ==> schema.
        • L912 Link to Avro doc targets /docs/faq. Replace with attribute that links to docs/configuration/avro/? Per comment from ccranfor@redhat.com, define link target via attribute.
        • L1496 L1773 List continuation
      • postgresql.adoc
        • L887 Anchor omitted in links to Avro serialization doc: #avro-serialization
        • L902 Anchor omitted in links to Avro serialization doc: #avro-serialization
        • L2298 list continuation
      • sqlserver.adoc
        • L805 Anchor omitted in links to Avro serialization doc: #avro-serialization
        • L820 Anchor omitted in links to Avro serialization doc: #avro-serialization
        • L1704 List continuation
        • L1897 ADD link to Avro (link:{link-avro-serialization}#avro-serialization)
        • L1962 ADD link to Avro
        • L2367 Line that includes xref to Avro doc is conditionalized as community content. Remove conditional?
      • partials/modules/all-connectors/proc-using-streams-to-deploy-a-debezium-connector.adoc
        • L178 Anchor omitted in links to Avro serialization doc: #avro-serialization Fixed in DBZ-4700.

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated:
              Resolved: