Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-4529

Build documentation previews on GitHub with ccutil

Prepare for Y ReleasePrepare for Z ReleaseRemove QuarterXMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • 1.3.1
    • Documentation
    • 3
    • False
    • Hide

      None

      Show
      None
    • False

      Currently, we build PRs on GitHub with a modern version of asciidoctor. Unfortunately, Pantheon behaves differently: it transforms Asciidoc files to docbook, and docbook to HTML with a special style template.

      Therefore sometimes build is successful on GitHub and fails on Pantheon: Pantheon fails when the files contains a duplicate ID. Asciidoctor des not check that.

      Also, sometimes the rendering in Pantheon is broken, when the Asciidoctor rendering is fine. Pantheon interprets differently some semantic notations such as complex lists, and might break the output.

      In the GitHub repository, there is already a script that builds all books with ccutil. This script was written to be used by contributors on their working environment.

      Use Ccutil to build pull requests on GitHub. Preferably, use the existing script and adapt it if required.

      It will help to:

      • Fail fast. Fail builds where Pantheon would fail.
      • Catch rendering issues early.

       

       

       

          There are no Sub-Tasks for this issue.

              ffloreth@redhat.com Fabrice Flore-Thébault
              ffloreth@redhat.com Fabrice Flore-Thébault
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: