Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-425

Add vale rules to check for valid PV2 AsciiDoc markup to Quarkus downstream docs Vale linter implementation

XMLWordPrintable

    • Quarkus Docs Sprint 12, Quarkus Docs Sprint 13

      Add a new set of rules to the vale linter implementation in the Quarkus repo to detect AsciiDoc Markup issues that could cause content rendering problems on PV2 or the customer portal. 

      Minimize doc bug churn.

      Use the asciidoc rules that were recently added to the vale-at-red-hat open source repo for OpenShift docs and tweak for our project.

      Add an asciidoc rule check to the downstream build job script.

       

      Explore whether this ruleset could be leveraged upstream too.

              mpurcell@redhat.com Michelle Purcell
              mpurcell@redhat.com Michelle Purcell
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: