From af18221ab76f87eddc1e6d6af615a4e9ab167a0e Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Tue, 19 Mar 2024 15:59:30 +0000 Subject: [PATCH] docs: Update links in the Documentation Requirements document This PR updates the url links in the Documentation Requirements document. Fixes #9306 Signed-off-by: Gabriela Cervantes --- docs/Documentation-Requirements.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Documentation-Requirements.md b/docs/Documentation-Requirements.md index e131b3f38..13f143a5f 100644 --- a/docs/Documentation-Requirements.md +++ b/docs/Documentation-Requirements.md @@ -105,7 +105,7 @@ This section lists requirements for displaying commands and command output. The requirements must be adhered to since documentation containing code blocks is validated by the CI system, which executes the command blocks with the help of the -[doc-to-script](https://github.com/kata-containers/tests/tree/main/.ci/kata-doc-to-script.sh) +[doc-to-script](https://github.com/kata-containers/kata-containers/blob/main/tests/kata-doc-to-script.sh) utility. - If a document includes commands the user should run, they **MUST** be shown @@ -189,7 +189,7 @@ and compare them with standard tools (e.g. `diff(1)`). Since this project uses a number of terms not found in conventional dictionaries, we have a -[spell checking tool](https://github.com/kata-containers/tests/tree/main/cmd/check-spelling) +[spell checking tool](https://github.com/kata-containers/kata-containers/tree/main/tests/cmd/check-spelling) that checks both dictionary words and the additional terms we use. Run the spell checking tool on your document before raising a PR to ensure it