github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-07-18 17:33:02 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #2100 from GabyCT/stable2.1docreq

Browse Source 
stable-2.1 | docs: Update urls for Documentation Requirements document
This commit is contained in:
Chelsea Mafrica 2021-06-23 23:33:03 -07:00 committed by GitHub
commit 28a815abe1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Documentation-Requirements.md
View File

@ -25,7 +25,7 @@ All documents must:
- Have a `.md` file extension. - Have a `.md` file extension.
- Include a TOC (table of contents) at the top of the document with links to - Include a TOC (table of contents) at the top of the document with links to
all heading sections. We recommend using the 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. tool to generate the TOC.
- Be linked to from another document in the same repository. - 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 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 is validated by the CI system, which executes the command blocks with the help
of the 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. utility.
- If a document includes commands the user should run, they **MUST** be shown - 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 Since this project uses a number of terms not found in conventional
dictionaries, we have a 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. 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 Run the spell checking tool on your document before raising a PR to ensure it