github/kata-containers
1
0
Fork 2
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-09-25 18:53:44 +00:00
Code Issues Projects Releases Wiki Activity

docs: reqs: add link/recommendation to check-markdown

Browse Source 
Recommend the use of our own check-markdown tool to generate
TOCs.

Fixes: #582

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
This commit is contained in:
Graham Whaley
2020-01-15 17:43:28 +00:00
parent 8f5cb26eba
commit 1af686c18d
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation-Requirements.md
View File

@@ -24,7 +24,9 @@ All documents must:
- Be written in [GitHub Flavored Markdown](https://github.github.com/gfm) format. - Be written in [GitHub Flavored Markdown](https://github.github.com/gfm) format.
- 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. all heading sections. We recommend using the
[`kata-check-markdown`](https://github.com/kata-containers/tests/tree/master/cmd/check-markdown)
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.
Although GitHub allows navigation of the entire repository, it should be Although GitHub allows navigation of the entire repository, it should be