Create a skeleton RST file
This will make creating new blueprints easier since authors can just fill in the sections, while consulting the template.rst file for what each section signifies. Change-Id: I9eb4547ed965b1305db956b1992532aec571ad3b
This commit is contained in:
parent
2903b782c0
commit
5b7b70e29d
@ -10,7 +10,11 @@ The layout of this repository is::
|
|||||||
|
|
||||||
specs/<release>/
|
specs/<release>/
|
||||||
|
|
||||||
You can find an example spec in `doc/source/specs/template.rst`.
|
You can find an example spec in `doc/source/specs/template.rst`. A
|
||||||
|
skeleton that contains all the sections required for a spec
|
||||||
|
file is located in `doc/source/specs/skeleton.rst` and can
|
||||||
|
be copied, then filled in with the details of a new blueprint for
|
||||||
|
convenience.
|
||||||
|
|
||||||
Specifications are proposed for a given release by adding them to the
|
Specifications are proposed for a given release by adding them to the
|
||||||
`specs/<release>` directory and posting it for review. The implementation
|
`specs/<release>` directory and posting it for review. The implementation
|
||||||
|
82
specs/skeleton.rst
Normal file
82
specs/skeleton.rst
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
..
|
||||||
|
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||||
|
License.
|
||||||
|
|
||||||
|
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||||
|
|
||||||
|
==========================================
|
||||||
|
Title of your blueprint
|
||||||
|
==========================================
|
||||||
|
|
||||||
|
|
||||||
|
Problem description
|
||||||
|
===================
|
||||||
|
|
||||||
|
|
||||||
|
Proposed change
|
||||||
|
===============
|
||||||
|
|
||||||
|
|
||||||
|
Alternatives
|
||||||
|
------------
|
||||||
|
|
||||||
|
|
||||||
|
Data model impact
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
REST API impact
|
||||||
|
---------------
|
||||||
|
|
||||||
|
|
||||||
|
Security impact
|
||||||
|
---------------
|
||||||
|
|
||||||
|
|
||||||
|
Notifications impact
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
|
||||||
|
Other end user impact
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
|
||||||
|
Performance Impact
|
||||||
|
------------------
|
||||||
|
|
||||||
|
|
||||||
|
Other deployer impact
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
|
||||||
|
Developer impact
|
||||||
|
----------------
|
||||||
|
|
||||||
|
|
||||||
|
Implementation
|
||||||
|
==============
|
||||||
|
|
||||||
|
Assignee(s)
|
||||||
|
-----------
|
||||||
|
|
||||||
|
|
||||||
|
Work Items
|
||||||
|
----------
|
||||||
|
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
============
|
||||||
|
|
||||||
|
|
||||||
|
Testing
|
||||||
|
=======
|
||||||
|
|
||||||
|
|
||||||
|
Documentation Impact
|
||||||
|
====================
|
||||||
|
|
||||||
|
|
||||||
|
References
|
||||||
|
==========
|
||||||
|
|
||||||
|
|
Loading…
x
Reference in New Issue
Block a user