docs/feature: Tweaks to the feature document template
authorAndrew Cooper <andrew.cooper3@citrix.com>
Tue, 26 Apr 2016 17:34:34 +0000 (18:34 +0100)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Mon, 23 May 2016 10:22:58 +0000 (11:22 +0100)
During review of the migration feature doc, some changes were made which
should have been reflected in the template.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Release-acked-by: Wei Liu <wei.liu2@citrix.com>
docs/features/template.pandoc

index 76982915598f350c45396757890239a43e9f5005..82881e3d219bbdb6b9414c0e31e6dc23c769cd25 100644 (file)
@@ -29,22 +29,22 @@ Architecture(s): e.g. x86, arm
 A short description the feature, similar to an abstract for a
 paper/presentation.
 
-# User information
+# User details
 
 Information for a user attempting to use the feature.  Should include
 how to enable the feature (is it enabled by default? If not, how to turn
 it on?), and how to interact with the feature (typically via `xl`).
 
+# Technical details
+
+Information for a developer or power user.  Should include where to look
+in-tree for detailed documents and code.
+
 # Limitations
 
 Information concerning incompatibilities with other features or hardware
 combinations.
 
-# Technical information
-
-Information for a developer or power user.  Should include where to look
-in-tree for detailed documents and code.
-
 # Testing
 
 Information concerning how to properly test changes affecting this feature.