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

Callout annotations rendered multiple times in downstream User Guide

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Minor Minor
    • 2.6.0.Beta1
    • None
    • documentation
    • None

      In the Debezium User Guide and Getting Started Guide, the numeric identifiers for callouts that follow some examples are listed on multiple lines, creating unneeded extra white space, and also raising the concern that information might be missing from each section.

      The problem is present in the following content:

      Book Chapter Topic Source
      JDBC connector 4.3.1 Deployment>Debezium JDBC connector configuration\ Example: Debezium JDBC connector configuration jdbc.adoc L569-583
      MongoDB connector 5.5.3. Deploying a Debezium MongoDB connector by building a custom Kafka Connect container image from a Dockerfile Step 2 MongoDB inventory-connector.yaml example mongodb.adoc L1368-1372
      PostgreSQL 8.5.4. Configuring PostgreSQL to allow replication with the Debezium connector host pg_hba.conf file example postgresql.adoc L2254-2256
      PostgreSQL 8.6.3. Deploying a Debezium PostgreSQL connector by building a custom Kafka Connect container image from a Dockerfile Step 2 inventory-connector.yaml example postgresql.adoc L2645-2660
      Debezium Logging 11.2 Default Debezium Logging Configuration\ connect-log4j.properties example operations/logging.adoc L86-91
      Configuration 12.3.1. Example Debezium change event records in CloudEvents format\ Configuring JSON as the CloudEvents envelope and data format. integrations/cloudevents.adoc L97-107
      Getting Started Viewing change events>Updating the database and viewing the update event Step 3 Example: update event value /partials/modules/tutorial/proc-updating-database-viewing-update-event.adoc L118-126

      The content renders correctly in the upstream documentation but not in the Customer Portal.
      To work around the problem, convert the existing callout description into table format, as is done elsewhere in the documentation.

       

              broldan@redhat.com Robert Roldan
              rhn-support-jsherman Jason Sherman
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: