From 3af75af4841fdf0ae0fb7a4b350fa3ff7f2fbc62 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Fri, 25 May 2018 08:06:12 +0100 Subject: [PATCH] docs: Add notes to doc requirements Add details to documentation requirements document explaining how we use and format notes. Fixes #125. Signed-off-by: James O. D. Hunt --- Documentation-Requirements.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/Documentation-Requirements.md b/Documentation-Requirements.md index c8025281c1..ecd78bc1c1 100644 --- a/Documentation-Requirements.md +++ b/Documentation-Requirements.md @@ -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.