From 78ae6dd107cc4bda9a5080640fb905745c6c120a Mon Sep 17 00:00:00 2001
From: Steve Piercy <web@stevepiercy.com>
Date: Fri, 4 Oct 2024 22:02:48 -0700
Subject: [PATCH] Remove pin on Vale, and upgrade to v3.x configuration (#6376)

---
 .github/workflows/docs.yml                           | 12 +++++-------
 Makefile                                             |  3 ++-
 packages/volto/news/6376.documentation               |  2 ++
 requirements-docs.txt                                |  2 +-
 .../{Vocab => config/vocabularies}/Base/accept.txt   |  0
 .../{Vocab => config/vocabularies}/Base/reject.txt   |  0
 .../{Vocab => config/vocabularies}/Plone/accept.txt  |  0
 .../{Vocab => config/vocabularies}/Plone/reject.txt  |  0
 8 files changed, 10 insertions(+), 9 deletions(-)
 create mode 100644 packages/volto/news/6376.documentation
 rename styles/{Vocab => config/vocabularies}/Base/accept.txt (100%)
 rename styles/{Vocab => config/vocabularies}/Base/reject.txt (100%)
 rename styles/{Vocab => config/vocabularies}/Plone/accept.txt (100%)
 rename styles/{Vocab => config/vocabularies}/Plone/reject.txt (100%)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 75da9c3140..0c868b5779 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -10,6 +10,9 @@ on:
     paths:
       - 'docs/**'
       - 'styles/**'
+      - '.github/workflows/docs.yml'
+      - 'requirements-docs.txt'
+      - '.vale.ini'
 
 jobs:
   docs:
@@ -32,9 +35,7 @@ jobs:
         run: pip install virtualenv
 
       - name: pip install requirements
-        run: |
-          pip install -r requirements-docs.txt
-          sudo snap install --edge vale
+        run: pip install -r requirements-docs.txt
 
       - name: Check for broken links
         run: make docs-linkcheckbroken
@@ -43,7 +44,4 @@ jobs:
         run: make docs-html
 
       - name: Run vale
-        run: |
-          git clone https://github.com/errata-ai/Microsoft.git
-          cp -r ./Microsoft/Microsoft ./styles
-          vale --no-exit ./docs
+        run: make docs-vale VALEOPTS=--no-exit
diff --git a/Makefile b/Makefile
index 4ff9cb9510..e7d46cea3c 100644
--- a/Makefile
+++ b/Makefile
@@ -16,6 +16,7 @@ include variables.mk
 # Sphinx variables
 # You can set these variables from the command line.
 SPHINXOPTS      ?=
+VALEOPTS        ?=
 # Internal variables.
 SPHINXBUILD     = "$(realpath bin/sphinx-build)"
 SPHINXAUTOBUILD = "$(realpath bin/sphinx-autobuild)"
@@ -120,7 +121,7 @@ docs-linkcheckbroken: bin/python docs-news  ## Run linkcheck and show only broke
 .PHONY: docs-vale
 docs-vale: bin/python docs-news  ## Install (once) and run Vale style, grammar, and spell checks
 	bin/vale sync
-	bin/vale --no-wrap $(VALEFILES)
+	bin/vale --no-wrap $(VALEOPTS) $(VALEFILES)
 	@echo
 	@echo "Vale is finished; look for any errors in the above output."
 
diff --git a/packages/volto/news/6376.documentation b/packages/volto/news/6376.documentation
new file mode 100644
index 0000000000..c8dc22516d
--- /dev/null
+++ b/packages/volto/news/6376.documentation
@@ -0,0 +1,2 @@
+Removed pin on Vale for documentation spelling, grammar, and style checks, and upgrade to v3.x configuration.
+Updated CI and `Makefile` to allow `VALEOPTS=--no-exit`. @stevepiercy
diff --git a/requirements-docs.txt b/requirements-docs.txt
index b42217e44c..406c7f60cd 100644
--- a/requirements-docs.txt
+++ b/requirements-docs.txt
@@ -7,4 +7,4 @@ sphinx-copybutton
 sphinx-examples
 sphinxcontrib-video
 sphinxext-opengraph
-vale==2.30.0
+vale
diff --git a/styles/Vocab/Base/accept.txt b/styles/config/vocabularies/Base/accept.txt
similarity index 100%
rename from styles/Vocab/Base/accept.txt
rename to styles/config/vocabularies/Base/accept.txt
diff --git a/styles/Vocab/Base/reject.txt b/styles/config/vocabularies/Base/reject.txt
similarity index 100%
rename from styles/Vocab/Base/reject.txt
rename to styles/config/vocabularies/Base/reject.txt
diff --git a/styles/Vocab/Plone/accept.txt b/styles/config/vocabularies/Plone/accept.txt
similarity index 100%
rename from styles/Vocab/Plone/accept.txt
rename to styles/config/vocabularies/Plone/accept.txt
diff --git a/styles/Vocab/Plone/reject.txt b/styles/config/vocabularies/Plone/reject.txt
similarity index 100%
rename from styles/Vocab/Plone/reject.txt
rename to styles/config/vocabularies/Plone/reject.txt