From 6005f8a499d040ed3e9f2c79023d0a76e7b3aa12 Mon Sep 17 00:00:00 2001 From: LandonTClipp Date: Tue, 26 May 2026 21:25:15 +0000 Subject: [PATCH] chore(docs): Add cspell makefile target for local testing This makes it easier to check the spellchecker is happy before submitting it as a PR. Signed-off-by: LandonTClipp --- Makefile | 10 +++++++++- docs/Documentation-Requirements.md | 2 +- docs/helm-configuration.md | 2 +- docs/runtime-configuration.md | 6 +++--- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index d91bf5a164..712f03cb5a 100644 --- a/Makefile +++ b/Makefile @@ -56,6 +56,11 @@ CSPELL_IMAGE ?= ghcr.io/streetsidesoftware/cspell@sha256:f02e91044d7ab4c31aab76e docs-spellcheck: docker run --rm -v ${PWD}:/workdir:ro -w /workdir ${CSPELL_IMAGE} --config .cspell.yaml "**/*.md" "**/*.rst" "**/*.txt" +docs-editorconfig-checker: + docker run --rm --volume=${PWD}:/check mstruebing/editorconfig-checker:v3.7 + +docs-lint: docs-spellcheck docs-editorconfig-checker + .PHONY: \ all \ kata-tarball \ @@ -63,4 +68,7 @@ docs-spellcheck: default \ static-checks \ docs-build \ - docs-serve + docs-serve \ + docs-spellcheck \ + docs-editorconfig-checker \ + docs-lint diff --git a/docs/Documentation-Requirements.md b/docs/Documentation-Requirements.md index 4f6b66acae..c02c481277 100644 --- a/docs/Documentation-Requirements.md +++ b/docs/Documentation-Requirements.md @@ -191,7 +191,7 @@ Since this project uses a number of terms not found in conventional dictionaries, we have a [kata-dictionary](../tests/spellcheck/kata-dictionary.txt) that contains some project specific terms we use. -You can run the `cspell` checking tool on your document before raising a PR to ensure it +You can run the `make docs-spellcheck` tool on your document before raising a PR to ensure it is free of mistakes. If your document introduces new terms, you need to update the custom diff --git a/docs/helm-configuration.md b/docs/helm-configuration.md index 0fca202971..ba7d5752da 100644 --- a/docs/helm-configuration.md +++ b/docs/helm-configuration.md @@ -96,7 +96,7 @@ Again, view the default [`values.yaml`](#parameters) file for more details. ### Drop-In Runtime Configuration The base runtime configuration shipped with Kata Containers can be modified using an -overlay method. This can be done directly on the filesystem using the instructions +overlay method. This can be done directly on the filesystem using the instructions found [here](runtime-configuration.md#drop-in-files). You can also use the `customRuntimes.runtimes.[name].dropIn` configuration in the helm chart to achieve the same results. diff --git a/docs/runtime-configuration.md b/docs/runtime-configuration.md index 1e7c3bb34c..69b15f4f89 100644 --- a/docs/runtime-configuration.md +++ b/docs/runtime-configuration.md @@ -3,9 +3,9 @@ ## Drop-in Files -When kata-deploy installs Kata Containers, the base configuration files at -`/opt/kata/bin/share/defaults` should not be modified directly. Instead, use -drop-in configuration files to customize settings. This approach ensures your +When kata-deploy installs Kata Containers, the base configuration files at +`/opt/kata/share/defaults/kata-containers` should not be modified directly. Instead, use +drop-in configuration files to customize settings. This approach ensures your customizations survive kata-deploy upgrades. ### How Drop-in Files Work