github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-07-14 23:55:49 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add warnings to doc requirements doc

Browse Source 
Document how other admonitions such as warnings and hints should be
handled.

Fixes #307.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2018-11-21 10:33:37 +00:00
parent e81421a5d1
commit ce85eb2ccd
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation-Requirements.md
View File

@ -1,6 +1,7 @@
* [Introduction](#introduction) * [Introduction](#introduction)
* [General requirements](#general-requirements) * [General requirements](#general-requirements)
* [Notes](#notes) * [Notes](#notes)
* [Warnings and other admonitions](#warnings-and-other-admonitions)
* [Files and command names](#files-and-command-names) * [Files and command names](#files-and-command-names)
* [Code blocks](#code-blocks) * [Code blocks](#code-blocks)
* [Images](#images) * [Images](#images)
@ -35,6 +36,24 @@ If there are multiple notes, bullets should be used:
> >
> - I am important point *n*. > - I am important point *n*.
# Warnings and other admonitions
Use the same approach as for [notes](#notes). For example:
> **Warning:** Running this command assumes you understand the risks of doing so.
Other examples:
> **Warnings:**
>
> - Do not unplug your computer!
> - Always read the label.
> - Do not pass go. Do not collect $200.
> **Tip:** Read the manual page for further information on available options.
> **Hint:** Look behind you!
# Files and command names # Files and command names
All filenames and command names should be rendered in a fixed-format font All filenames and command names should be rendered in a fixed-format font