Uploaded image for project: 'Debezium'
  1. Debezium
  2. DBZ-9130 Prepare asciidoc files for migration to DITA
  3. DBZ-9286

Remove hard line breaks from MariaDB and MySQL properties lists

XMLWordPrintable

      To prepare the documentation for the downstream migration to DITA, it's necessary to eliminate hard line breaks implemented by adding trailing + characters to lines.

      In the shared files that documents the MariaDB and MySQL required and advanced properties, I believe that most of the hard breaks are extraneous.

      In contrast to the way that configuration properties are documented for the other connectors, the shared files for the MariaDB and MySQL connectors present the properties as definition lists. These connectors mostly use the same set of properties, but to account for some variations, it was necessary to apply conditionalization. Conditionalization is much simpler to implement in a description list than in a table.

      Each entry in the list provides the following information:

      • Property name
      • Default value
      • Description
      • Options

      In the current versions of these files, hard break after the Default value field helps to set off that information on its own line, improving scannability and readability.

      After some experimentation, I believe that it might be possible to dispense with the use of line breaks. For example:

      property name:: prop-name

      [horizontal]

      Default value::: `prop-value`

      Description::: description text

      `option1`:::: option description

      `option2`::: option description

       

      property name 2::
      [horizontal]
      Default value::: `prop-value`

      Description::: description text
      `option1`:::: option description

      `option2`::: option description
       

      This renders correctly as:

      property name prop-name

      Default value prop-value
      Description
      option1 option description

      option2 option description
      etc...

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

                Created:
                Updated:
                Resolved: