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

Fix splitter annotations that control how content is modularized downstream

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • 1.4.0.Beta1
    • None
    • documentation
    • None

    Description

      Fix the following errors in the annotation comments that are used to render sqlserver.adoc for downstream:

      • A hyphen is incorrectly replaced by a space in the annotation that accompanies the heading Data type mappings. Instead of how-debezium-SQL Server-connectors-map-data-types, the annotation should be how-debezium-SQL-Server-connectors-map-data-types. As a result, the name of the generated file contains an illegal space character.
      • The subtopic Change data event enrichment in Transaction metadata is missing an annotation comment, with the result that a topic file is not created downstream.
      • In Setting up SQL Server, the boundaries are not set correctly for the conditionalization tags that designate content for use in the community and product versions of the documentation. As a result, some content is incorrectly propagated to the downstream version of the file that the annotation generates (assembly-setting-up-sql-server-for-use-with-the-debezium-sql-server-connector.adoc), and some community content leaks through.

      In the process of testing the file for use in the downstream build, I discovered that some further updates were needed to provide consistency with the doc for other connectors, standardize, terminology, and replace poorly formed module IDs (white spaces, inconsistent hyphenation, capitalization, etc).

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated:
              Resolved: