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

Test docs for productization and fix broken links and rendering errors

XMLWordPrintable

      Review the downstream docs to test links, identify errors in rendering or content
      Requires both upstream and downstream fixes.

      Detected the following errors:

      Getting Started Guide

      Deleting a record in the database and viewing the delete event

      (Upstream file: {debezium-mysql-tutorial-module}\/proc-deleting-record-database-viewing-delete-event.adoc

      Redundant callouts for descriptions of event value fields.
      As elsewhere in the documentation, the mechanism for generating the callout legend that follows an example does not correctly render in the Customer Portal.

      • Convert to a table DONE

      OCP Install guide

      Ch 1. Overview

      (modules\/debezium-installing\/con-debezium-overview.adoc)

      • Add MariaDB to list of connectors DONE

      2.1 Kafka topic creation recommendations

      (\/modules\/debezium-installing\/ref-topic-recommendations.adoc)

      Other topics

      • Add missing #compaction anchor ID to link to Kafka log compaction DONE

      2.2.1 Deploying Debezium with Streams for Apache Kafka

      (modules\/all-connectors\/ref-deploy-{context}-kafka-connect-yaml.adoc)

      • Example 2.1, third bullet: Add these components only if you intend to use the Debezium content-based routing SMT or filter SMT.
        The links to the Content-based routing and filter SMTs point to the upstream anchor IDs, not to the downstream ModuleIDs. For example, the link to content-based-routing should point to routing-change-event-records-to-topics-according-to-event-content.
        Similarly, the link to message-filtering should point to filtering-debezium-change-event-records

       

      Ch.2.2.2 Verifying that the connector is running

      Next steps

      • Add MariaDB to list of connectors DONE

       

      RHEL Install

      Ch. 2.3 Deploying Debezium with Streams for Apache Kafka on RHEL

      (debezium-installing\/proc-deploying-debezium-on-rhel.adoc)

       Prereqs

      • 1st bullet: For information about how to install Streams for Apache Kafka, see Installing AMQ Streams.
        Correct the link text to point to {LinkStreamsRhel}{NameStreamsRhel}]}} (i.e, Using Streams for Apache Kafka on RHEL with ZooKeeper). DONE
      • 2nd bullet - Running a single node Streams for Apache Kafka cluster should point to: using_streams_for_apache_kafka_on_rhel_with_zookeeper\/index#proc-running-kafka-str in Using Streams for Apache Kafka on RHEL
        DONE

      Procedure

      • Step 1: Download the Debezium connector or connectors that you want to use from the Red Hat Integration download site.
        Update the link text to refer to Red Hat Build of Debezium (i.e., {ProductLongName}) DONE

      Additional resources

      • In the bullet, the link text Adding connector plugins, does not jump to the intended topic, but to the title, Using Streams for Apache Kafka on RHEL w/ ZooKeeper. DONE
      • Adjust the link to target to {LinkStreamsRhel}#con-kafka-connect-connector-plugins-str DONE

      Ch. 2.4 Verifying the deployment

      (docs\/debezium-rhel-install\/modules\/debezium-installing\/proc-verifying-debezium-installation-on-rhel.adoc)

      Prereqs

      • The Procedure title is incorrectly merged into the bullet text. Insert a blank line after the link text and before the title text. DONE

      Next steps

      • For information about the configuration settings that are available for each connector, and to learn how to configure source databases to enable change data capture, see the Debezium User Guide
      • The link to the Debezium User Guide is malformed, and opens opens to the overview of Installing Debezium on RHEL, because it omits curly braces around the attribute name and does not specify an anchor ID (link:LinkDebeziumUserGuide[
        {NameDebeziumUserGuide}])
        .
      • Format the attribute name and append the anchor link, #debezium-user-guide DONE

      2.5 Updating Debezium connector plug-ins

      (\/modules/debezium-installing\/proc-updating-debezium-connectors-on-rhel.adoc

      • Step 1: The link text refers to the Red Hat Integration download site. Update the text to refer to Red Hat Build of Debezium (i.e., {ProductLongName}) DONE

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

              Created:
              Updated:
              Resolved: