Added Vale check action for CI testing(DO NOT MERGE)

Author: gaurav-nelson

.github/workflows/lint-with-vale.yml

@@ -0,0 +1,30 @@
+---
+name: Lint with Vale on pull requests
+on:
+  pull_request:
+    paths:
+      - '**.adoc'
+      - '**.md'
+      - 'content/learn/**'
+      - 'content/patterns/**'
+      - 'content/contribute/**'
+      - 'modules/**'
+      - 'README.md'
+
+jobs:
+  vale-lint:
+    name: Linting with Vale
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Install Asciidoctor
+        run: sudo apt-get install -y asciidoctor
+      - uses: errata-ai/[email protected]
+        with:
+          version: 3.12.0
+          filter_mode: diff_context
+          vale_flags: "--no-exit --minAlertLevel=error"
+          fail_on_error: false
+          reporter: github-pr-annotations
+          token: ${{ secrets.VALE_GITHUB_TOKEN }}

.gitignore

@@ -16,4 +16,4 @@ Gemfile.lock
 .idea
 .vale
 modules/.vale.ini
-.vale.ini
+.vale

.vale.ini

@@ -0,0 +1,37 @@
+StylesPath = .vale/styles
+
+MinAlertLevel = warning
+
+IgnoredScopes = code, tt, img, url, a, body.id
+
+SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
+
+Packages = RedHat, AsciiDoc
+
+[*.adoc]
+
+BasedOnStyles = RedHat, AsciiDoc
+
+[*.md]
+
+BasedOnStyles = RedHat
+
+# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
+TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
+
+# Match INI files. See: https://docs.errata.ai/vale/scoping
+[*.ini]
+
+BasedOnStyles = RedHat
+
+# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
+TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
+
+# Disabling rules (NO)
+RedHat.CaseSensitiveTerms = NO
+RedHat.ConfigMap = NO
+RedHat.Definitions = NO
+RedHat.Slash = NO
+RedHat.Spacing = NO
+RedHat.Spelling = NO
+RedHat.TermsSuggestions = NO

README.md

@@ -4,11 +4,11 @@ This project contains the new proof-of-concept documentation site for [validated
 
 Use a container image to build the Validated Patterns documentation, locally. See [Preview the documentation using a container image](https://validatedpatterns.io/contribute/contribute-to-docs/#_preview_the_documentation_using_a_container_image). This is recommended to ensure the local preview is the same as what is rendered in deployment pipelines.
 
-Alternatively, you can build this site using [Hugo](https://gohugo.io/) and [Asciidoctor](https://asciidoctor.org). 
+Alternatively, you can build this site using [Hugo](https://gohugo.io/) and [Asciidoctor](https://asciidoctor.org).
 
 ## Install Hugo
 
-You can install Hugo on different platforms (Linux, Windows, macOS) using a number of methods. For more information on how to install Hugo on your desired platform, see [Install Hugo](https://gohugo.io/getting-started/installing/).
+You can install Hugo on different platforms (Linux, Windows, macOS) using a number of methods. For more information on how to install Hugo on your desired platform, see [Install Hugo](https://gohugo.io/getting-started/installing/). Using several for testing.
 
 ## Install Asciidoctor