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

Documentation updates to prepare for downstream publication

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 2.3.GA
    • None
    • documentation
    • None

       

      To produce downstream documentation for the 2.3.x release, we need to make several updates to the asciidoc sources. 

      The following files require new Nebel annotations so so that they can be used downstream:

      • JDBC sink connector
      • Event record changes SMT - Prepare for downstream use
      • Notifications

       

      Conditionalize content that should not be exposed downstream:

      • Conditionalize custom notifications content as community only 
      • Conditionalize custom signaling content as community only

      In signaling.adoc and notification.adoc, and in descriptions for signal.enabled.channels and{{ notification.enabled.channels}} entries in connector properties tables

      Add notes to indicate that content is DP/TP:

      • Oracle standby - Update Standby databases topic to add conditionalized note to specify that this is a DP feature (L2369-2387) 
      • Incremental snapshots for sharded MongoDB clusters-  Add conditionalized note to specify that is a TP feature (L327) 

           (Incremental snapshots are already listed as TP for MongoDB, so I added a note to explicitly state that snapshots for sharded clusters are also TP.)

      Add the following attributes to{} antora.yml:

      • link-jdbc-connector: 'connectors/jdbc.adoc'
      • link-notifications: 'configuration/notification.adoc'
      • link-event-record-changes: 'transformations/event-changes.adoc'

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

                Created:
                Updated:
                Resolved: