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

Asciidoc throw warnings while building documentation

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Minor
    • 1.1-next, 1.3.0.Beta1
    • 1.1.3.Final, 1.3.0.Alpha1
    • documentation
    • None

    Description

      During the documentation build phase, the following errors are observed:

      Branch: 1.3

      asciidoctor: WARNING: content-based-routing.adoc: line 76: invalid style for listing block: TIP
      asciidoctor: WARNING: filtering.adoc: line 76: invalid style for listing block: TIP
      

      The above errors occur on branch 1.3
      The error indicates that the usage of TIP is incorrect. What was observed is that these files define the TIP sections as

      [TIP]
      ----
      text
      ----
      

      but should be formatted as

      [TIP]
      ====
      text
      ====
      

      This requires that branch 1.3 be fast-forwarded (which will happen during the next release cycle) and this fix will be there.

      In addition to these, the following are observed on the 1.1 branch only.

      asciidoctor: WARNING: oracle.adoc: line 993: unterminated table block
      asciidoctor: WARNING: oracle.adoc: line 1049: section title out of sequence: expected level 1, got level 3
      asciidoctor: WARNING: oracle.adoc: line 1093: section title out of sequence: expected level 1, got level 2
      asciidoctor: WARNING: skipping reference to missing attribute: link-java7-standard-names
      

      Ideally it would be helpful to push some small fixes to each branch respectively to correct the build warnings for that branch so we keep the build clean of warnings/errors.

      Attachments

        Activity

          People

            ccranfor@redhat.com Chris Cranford
            ccranfor@redhat.com Chris Cranford
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: