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

docs: Requirements for filenames and commands

Browse Source 
Explain how to handle filenames and command names in documentation.

Fixes #187.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2018-07-04 10:03:05 +01:00
parent 0e966255d1
commit 86cde89809
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)
* [General requirements](#general-requirements)
* [Notes](#notes)
* [Files and command names](#files-and-command-names)
* [Code blocks](#code-blocks)
# Introduction
@ -33,6 +34,24 @@ If there are multiple notes, bullets should be used:
>
> - I am important point *n*.
# Files and command names
All filenames and command names should be rendered in a fixed-format font
using backticks:
> Run the `foo` command to make it work.
> Modify the `bar` option in file `/etc/baz/baz.conf`.
Render any options that need to be specified to the command in the same manner:
> Run `bar -axz --apply foo.yaml` to make the changes.
For standard system commands, it is also acceptable to specify the name along
with the manual page section that documents the command in brackets:
> The command to list files in a directory is called `ls(1)`.
# Code blocks
This section lists requirements for displaying commands and command output.