Add doc-validator tool to CI (#51698) (#51869)

* Add doc-validator tool to CI Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use simpler apostrophe to make title match h1 Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Ensure doc-validator CI always passes until all errors are resolved Signed-off-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 602ee37533) Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2022-07-07 09:23:08 +01:00
parent 82269e8520
commit e4158d654d
9 changed files with 24 additions and 8 deletions
@@ -0,0 +1,16 @@
+name: "doc-validator"
+on:
+  pull_request:
+    paths: ["docs/sources/**"]
+  workflow_dispatch:
+jobs:
+  doc-validator:
+    runs-on: "ubuntu-latest"
+    container:
+      image: "grafana/doc-validator:latest"
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v3"
+      - name: "Run doc-validator tool"
+        # Ensure that the CI always passes until all errors are resolved.
+        run: "doc-validator ./docs/sources || true"