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

Initial Vale DITA compatibility assessment

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Blocker Blocker
    • None
    • None
    • None
    • None
    • False
    • Hide

      None

      Show
      None
    • False

      Perform a Vale run on your repository using the AsciidocDITA package.

      Linked reports:

      I ran Vale on the assemblies and modules folders of the downstream repository, and on the upstream files in the /partials directory, which are incorporated as-is into the downstream build.
      I might remove the report for the /partials folder, because the problems reported in that segment should be duplicated in the downstream files that incorporate that content.
      However, the /partials report should be useful when it comes to fixing problems in the sources, because after the tooling incorporates content from a shared file, tracing a problem back to the source requires an extra step.

      In general, I chose not to run Vale against the upstream User Guide sources so as to filter out errors in any content that is not exposed downstream and therefore not relevant to our purposes.

      I still need to run additional reports for the following Debezium documentation:

      • RHEL installation guide (uses combination of shared upstream sources and some downstream-only sources).
      • OCP installation guide (mostly downstream-only sources, with some of the same upstream content that the RHEL guide shares).
      • Getting started guide (uses combination of shared upstream tutorial sources and some downstream-only sources).
      • Release notes (These require restructuring. Currently all content exists within a single file).

      TBD: Create bugs to fix the issues found by Vale, add them as children to the parent (Phase 0) Epic, and fix them.

              broldan@redhat.com Robert Roldan
              rhn-support-tradej Tomas 'Sheldon' Radej
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: