docker · mdelapenya · Feb 28, 2025 · Feb 28, 2025 · Mar 11, 2025 · Mar 11, 2025
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -103,6 +103,21 @@ $ docker buildx bake validate
 
 If this command doesn't result in any errors, you're good to go!
 
+#### Running Vale
+
+Vale is a tool that checks for spelling and grammar errors in your text. To run Vale
+for the content in the `content` directory, use the following command:
+
+```console
+$ make vale
+```
+
+You can also specify a different directory for Vale to check. For example:
+
+```console
+$ CONTENT_DIR="content/manuals/compose" make vale
+```
+
 ## Content not edited here
 
 CLI reference documentation is maintained in upstream repositories. It's

diff --git a/Makefile b/Makefile
@@ -1,3 +1,18 @@
+# Directory containing the content to validate. Default is "content".
+# It can be overridden by setting the CONTENT_DIR environment variable.
+# Example: CONTENT_DIR=content/manuals/compose make vale
+CONTENT_DIR := $(or $(CONTENT_DIR), content)
+
+# Docker image to use for vale.
+VALE_IMAGE := jdkato/vale:latest
+
+.PHONY: vale
+vale: ## run vale
+	docker run --rm -v $(PWD):/docs \
+		-w /docs \
+		-e PIP_BREAK_SYSTEM_PACKAGES=1 \
+		$(VALE_IMAGE) $(CONTENT_DIR)
 target "lint" { 
   target = "lint" 
   output = ["type=cacheonly"] 
   provenance = false 
 } 
 # lint lints markdown files 
 FROM davidanson/markdownlint-cli2:v0.14.0 AS lint 
 USER root 
 RUN --mount=type=bind,target=. \ 
     /usr/local/bin/markdownlint-cli2 \ 
     "content/**/*.md" \ 
     "#content/manuals/engine/release-notes/*.md" \ 
     "#content/manuals/desktop/previous-versions/*.md" 
 group "validate" { 
   targets = ["lint", "test", "unused-media", "test-go-redirects", "dockerfile-lint", "path-warnings"] 
 } 
 vale: 
   if: ${{ github.event_name == 'pull_request' }} 
   runs-on: ubuntu-24.04 
   steps: 
     - uses: actions/checkout@v4 
     - uses: errata-ai/vale-action@reviewdog 
       env: 
         PIP_BREAK_SYSTEM_PACKAGES: 1 
       with: 
         files: content 
 target: 
   - lint 
   - test 
   - unused-media 
   - test-go-redirects 
   - dockerfile-lint 
   - path-warnings 
 target "lint" { 
   target = "lint" 
   output = ["type=cacheonly"] 
   provenance = false 
 } 
 # lint lints markdown files 
 FROM davidanson/markdownlint-cli2:v0.14.0 AS lint 
 USER root 
 RUN --mount=type=bind,target=. \ 
     /usr/local/bin/markdownlint-cli2 \ 
     "content/**/*.md" \ 
     "#content/manuals/engine/release-notes/*.md" \ 
     "#content/manuals/desktop/previous-versions/*.md" 
 group "validate" { 
   targets = ["lint", "test", "unused-media", "test-go-redirects", "dockerfile-lint", "path-warnings"] 
 } 
 vale: 
   if: ${{ github.event_name == 'pull_request' }} 
   runs-on: ubuntu-24.04 
   steps: 
     - uses: actions/checkout@v4 
     - uses: errata-ai/vale-action@reviewdog 
       env: 
         PIP_BREAK_SYSTEM_PACKAGES: 1 
       with: 
         files: content 
 target: 
   - lint 
   - test 
   - unused-media 
   - test-go-redirects 
   - dockerfile-lint 
   - path-warnings 
+
 .PHONY: vendor
 vendor: ## vendor hugo modules
 	./hack/vendor