From 7c80f31bf50bca8c1e8b80e96c0726dad5ab3d6d Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Wed, 23 Jun 2021 15:16:13 +0000 Subject: [PATCH] docs: Update urls for Documentation Requirements document This PR updates the proper urls for the Documentation Requirements document. Fixes #2094 Signed-off-by: Gabriela Cervantes --- docs/Documentation-Requirements.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Documentation-Requirements.md b/docs/Documentation-Requirements.md index c1cea47a40..1971f0ba14 100644 --- a/docs/Documentation-Requirements.md +++ b/docs/Documentation-Requirements.md @@ -25,7 +25,7 @@ All documents must: - Have a `.md` file extension. - Include a TOC (table of contents) at the top of the document with links to all heading sections. We recommend using the - [`kata-check-markdown`](https://github.com/kata-containers/tests/tree/master/cmd/check-markdown) + [`kata-check-markdown`](https://github.com/kata-containers/tests/tree/main/cmd/check-markdown) tool to generate the TOC. - Be linked to from another document in the same repository. @@ -118,7 +118,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/master/.ci/kata-doc-to-script.sh) +[doc-to-script](https://github.com/kata-containers/tests/tree/main/.ci/kata-doc-to-script.sh) utility. - If a document includes commands the user should run, they **MUST** be shown @@ -202,7 +202,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/master/cmd/check-spelling) +[spell checking tool](https://github.com/kata-containers/tests/tree/main/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