Check documentation for style in GH pull requests (#669)

Co-authored-by: Nick Boldt <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

Author: 3 people

.github/workflows/style-guide.yml

@@ -0,0 +1,22 @@
+---
+name: Verify style guide compliance on pull request
+on: [pull_request]
+
+jobs:
+  vale:
+    name: Linting with Vale
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Asciidoctor
+        run: sudo apt-get install -y asciidoctor
+      - name: Run Vale on new and modified content
+        uses: errata-ai/[email protected]
+        with:
+          files: assemblies
+          vale_flags: "--minAlertLevel=warning"
+          reporter: github-pr-review
+        env:
+          GITHUB_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}

.gitignore

@@ -2,7 +2,6 @@
 titles/*/build
 index.html
 titles-generated/
-.vale.ini
 .vale-styles/RedHat
 .vscode
 .cache/

.vale-styles/DeveloperHub/tests/.vale.ini

@@ -0,0 +1,12 @@
+; .vale.ini
+; Specifies Vale configuration
+; See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/
+;
+; Download and search Vale styles in this directory:
+StylesPath = ../..
+; Minimum alert level to display:
+MinAlertLevel = suggestion
+; Display alerts on AsciiDoc files:
+[*.adoc]
+; Apply these styles:
+BasedOnStyles = DeveloperHub

.vale.ini

@@ -0,0 +1,18 @@
+# .vale.ini
+# Specifies Vale configuration
+# See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/
+#
+
+# Download and search Vale styles in this directory:
+StylesPath = ".vale-styles"
+
+# Minimum alert level to display:
+MinAlertLevel = suggestion
+
+# Styles to download:
+Packages = RedHat
+
+# Display alerts on AsciiDoc files:
+[*.adoc]
+# Apply these styles:
+BasedOnStyles = RedHat,DeveloperHub