From 4c78814bdaa8b72b09d5bafa6d587f843ff5f0f9 Mon Sep 17 00:00:00 2001 From: Christophe de Dinechin Date: Mon, 9 Nov 2020 16:52:33 +0100 Subject: [PATCH] docs: Fix pre-existing spelling mistakes caught by the CI The documentation contains existing spelling mistakes that are caught by the CI and prevent checking in. The errors include: INFO: Spell checking file 'docs/how-to/how-to-load-kernel-modules-with-kata.md' WARNING: Word 'configurated': did you mean one of the following?: configuration, reconfigured, Confederate, confederate WARNING: Word 'cri': did you mean one of the following?: cir, crib, chi, cry, Fri, crier ERROR: Spell check failed for file: 'docs/how-to/how-to-load-kernel-modules-with-kata.md' INFO: spell check failed for document docs/how-to/how-to-load-kernel-modules-with-kata.md INFO: Spell checking file 'docs/how-to/how-to-set-sandbox-config-kata.md' INFO: Spell check successful for file: 'docs/how-to/how-to-set-sandbox-config-kata.md' ERROR: spell check failed, See https://github.com/kata-containers/documentation/blob/master/Documentation-Requirements.md#spelling for more information. Signed-off-by: Christophe de Dinechin --- docs/how-to/how-to-load-kernel-modules-with-kata.md | 2 +- docs/how-to/how-to-set-sandbox-config-kata.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/how-to/how-to-load-kernel-modules-with-kata.md b/docs/how-to/how-to-load-kernel-modules-with-kata.md index 77ade9797..24a354601 100644 --- a/docs/how-to/how-to-load-kernel-modules-with-kata.md +++ b/docs/how-to/how-to-load-kernel-modules-with-kata.md @@ -102,7 +102,7 @@ spec: tty: true ``` -> **Note**: To pass annotations to Kata containers, [cri must to be configurated correctly](how-to-set-sandbox-config-kata.md#cri-configuration) +> **Note**: To pass annotations to Kata containers, [CRI-O must be configured correctly](how-to-set-sandbox-config-kata.md#cri-o-configuration) [1]: ../../src/runtime [2]: ../../src/agent diff --git a/docs/how-to/how-to-set-sandbox-config-kata.md b/docs/how-to/how-to-set-sandbox-config-kata.md index f58b90e6e..72cdf1304 100644 --- a/docs/how-to/how-to-set-sandbox-config-kata.md +++ b/docs/how-to/how-to-set-sandbox-config-kata.md @@ -91,7 +91,7 @@ There are several kinds of Kata configurations and they are listed below. | `io.katacontainers.config.hypervisor.virtio_fs_daemon` | string | virtio-fs `vhost-user` daemon path | | `io.katacontainers.config.hypervisor.virtio_fs_extra_args` | string | extra options passed to `virtiofs` daemon | -# CRI Configuration +# CRI-O Configuration In case of CRI-O, all annotations specified in the pod spec are passed down to Kata.