mirror of
https://github.com/kata-containers/kata-containers.git
synced 2026-06-30 22:21:05 +00:00
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 <lclipp@coreweave.com>
This commit is contained in:
committed by
Fabiano Fidêncio
parent
03c283edec
commit
6005f8a499
10
Makefile
10
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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user