Merge pull request #3754 from platformsh/vale-fix

Fix Vale errors on CLI generated pages.
platformsh · Feb 12, 2024 · b69abe9 · b69abe9
2 parents ff7c33c + c55bb5d
commit b69abe9
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 10 deletions.
diff --git a/.github/workflows/linting.yaml b/.github/workflows/linting.yaml
@@ -47,7 +47,7 @@ jobs:
       - name: Vale
         uses: errata-ai/vale-action@reviewdog
         with:
-          version: 2.30.0
+          version: 3.0.7
           fail_on_error: true
           reporter: github-check
           files: sites/platform/src

diff --git a/...ributing/styles/Vocab/Platform/accept.txt → ...s/config/vocabularies/Platform/accept.txt b/...ributing/styles/Vocab/Platform/accept.txt → ...s/config/vocabularies/Platform/accept.txt
@@ -69,8 +69,7 @@ IPs?
 JVM
 imagetragick
 jpegoptim
-Kafka
-kafka
+[Kk]afka
 Lando
 Laravel
 Loggly
@@ -155,8 +154,7 @@ scp
 seccomp
 serverless
 Servlet
-sftp
-SFTP
+[Ss][Ff][Tt][Pp]
 shard
 shortcode
 Slowloris
@@ -168,8 +166,7 @@ Strapi
 [Ss]ubprocessor
 subuser
 Swoole
-Symfony
-symfony
+[Ss]ymfony
 [Ss]yslog
 systemd
 Thorntail

diff --git a/...ributing/styles/Vocab/Platform/reject.txt → ...s/config/vocabularies/Platform/reject.txt b/...ributing/styles/Vocab/Platform/reject.txt → ...s/config/vocabularies/Platform/reject.txt
diff --git a/shared/scripts/gen-cli-docs.sh b/shared/scripts/gen-cli-docs.sh
@@ -3,13 +3,15 @@
 cp shared/pages/commands.md $1
 
 VERSION=$($2 version)
+
+printf "\n<!-- vale off -->\n" >> $1
+
 printf "\n# $VERSION\n" >> $1
 
 printf "\n- [Installation](/administration/cli#1-install)" >> $1
 printf "\n- [Open an issue](https://github.com/platformsh/cli/issues)\n" >> $1
 
 printf "\n## All commands\n" >> $1
-printf "\n<!-- vale off -->\n" >> $1
 
 $2 list --format=md | tail -n +2 >> $1
 

diff --git a/sites/friday/src/administration/cli/reference.md b/sites/friday/src/administration/cli/reference.md
@@ -11,7 +11,9 @@ showTitle: false
     }
 </style>
 
-# Upsun CLI 5.0.8
+<!-- vale off -->
+
+# Upsun CLI 5.0.9
 
 - [Installation](/administration/cli#1-install)
 - [Open an issue](https://github.com/platformsh/cli/issues)
@@ -8469,3 +8471,5 @@ upsun workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVI
   Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1
 
 
+
+<!-- vale on -->
diff --git a/sites/platform/src/administration/cli/reference.md b/sites/platform/src/administration/cli/reference.md
@@ -11,7 +11,9 @@ showTitle: false
     }
 </style>
 
-# Platform.sh CLI 5.0.8
+<!-- vale off -->
+
+# Platform.sh CLI 5.0.9
 
 - [Installation](/administration/cli#1-install)
 - [Open an issue](https://github.com/platformsh/cli/issues)
@@ -8421,3 +8423,5 @@ platform workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment E
   Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1
 
 
+
+<!-- vale on -->