Add note about boilerplate content

Provide guidance in the template to remove the boilerplate
text. Many specs have much of the boiler plate remaining
including the description of how to use the spec template.
The boilerplate content should not be left in specs.

Change-Id: I974764f1534efd0530517bd74a52a5a5b70b898f
This commit is contained in:
Morgan Fainberg 2018-12-14 07:20:44 -08:00
parent a0fc67e045
commit 5c30c61989
1 changed files with 3 additions and 1 deletions

View File

@ -10,7 +10,6 @@ Example Spec - The title of your blueprint
`bug #XXXXXXX <https://bugs.launchpad.net/keystone/+bug/XXXXXXX>`_ `bug #XXXXXXX <https://bugs.launchpad.net/keystone/+bug/XXXXXXX>`_
Introduction paragraph -- why are we doing anything? A single paragraph of Introduction paragraph -- why are we doing anything? A single paragraph of
prose that operators can understand. prose that operators can understand.
@ -46,6 +45,9 @@ Some notes about using this template:
* Do not delete any of the sections in this template. If you have * Do not delete any of the sections in this template. If you have
nothing to say for a whole section, just write: None nothing to say for a whole section, just write: None
Note that the boilerplate text should be replaced with real text or
``None``.
* To test out your formatting, build the docs using tox, or see: * To test out your formatting, build the docs using tox, or see:
http://rst.ninjs.org http://rst.ninjs.org