github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-15 06:34:03 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #126 from jodh-intel/more-doc-requirements

Browse Source 
docs: Add notes to doc requirements
This commit is contained in:
Archana Shinde 2018-05-29 13:53:29 -07:00 committed by GitHub
commit 8e3bc751c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation-Requirements.md
View File

@ -1,5 +1,6 @@
* [Introduction](#introduction)
* [General requirements](#general-requirements)
* [Notes](#notes)
* [Code blocks](#code-blocks)
# Introduction
@ -12,6 +13,26 @@ Containers](https://github.com/kata-containers) project.
- All documents are expected to be written in [GitHub Flavored Markdown](https://github.github.com/gfm) format.
- All documents should have the `.md` file extension.
# Notes
Important information that is not part of the main document flow should be
added as a Note in bold with all content contained within block quote:
> **Note:** This is areally important point!
>
> This particular note also spans multiple lines. The entire note should be
> included inside the quoted block.
If there are multiple notes, bullets should be used:
> **Notes:**
>
> - I am important point 1.
>
> - I am important point 2.
>
> - I am important point *n*.
# Code blocks
This section lists requirements for displaying commands and command output.