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

Research and test CI automation of Vale linter in our downstream docs git workflow

XMLWordPrintable

    • 5
    • False
    • Hide

      None

      Show
      None
    • False

      Explore how we can increase and scale content quality in Quarkus downstream docs by running the Vale client linter (configured with the Red Hat style ruleset) automatically in our Git Workflow.

      Benefits:

      • Common Red Hat docs style issues are detected automatically during the early iterations.
      • Encourages consistency across Quarkus docs writers.
      • Speeds up the peer review work (Reduces comments, therefore churn and work) and enables the peer reviewer to focus on minimalism.
      • We can add Quarkus-specific terminology checks to a custom ruleset.
      • Aligns with CCS doc strategies: 1) Scale and 2) Docs-as-code

      This task is done when we have a working demo of:

      • CI integration for Vale (with the vale-at-red-hat style ruleset) is enabled on the Quarkus docs GitLab project.
      • Merge request generates a Vale linter job to check for non-compliance of Red Hat Style issues.
      • A validation check is added to the 'merge' event to ensure that the content does not contain a 'serious' style error.
      • 1st iteration of documentation for how to enable Vale CI integration in gitlab.

              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: