Add a template for design specifications

This covers the general formatting we expect as well as the level of
detail we are looking for.

Shamelessly stolen from the nova specs directory and then mangled
for our purposes.

Change-Id: I829d5216621edc7f7741bc277224c517162bd2a7
This commit is contained in:
Chris Yeoh 2014-03-21 14:20:01 +10:30 committed by Matthew Treinish
parent bc2e7c5ae4
commit 1f544acfd3
3 changed files with 95 additions and 0 deletions

View File

@ -11,6 +11,7 @@ Contents:
:maxdepth: 2
README
template
specs/*
-----------

1
doc/source/template.rst Symbolic link
View File

@ -0,0 +1 @@
../../template.rst

93
template.rst Normal file
View File

@ -0,0 +1,93 @@
::
This work is licensed under a Creative Commons Attribution 3.0 Unported License.
http://creativecommons.org/licenses/by/3.0/legalcode
..
This template should be in ReSTructured text. The filename in the git
repository should match the launchpad URL, for example a URL of
https://blueprints.launchpad.net/tempest/+spec/awesome-thing should be named
awesome-thing.rst . Please do not delete any of the sections in this
template. If you have nothing to say for a whole section, just write: None
For help with syntax, see http://sphinx-doc.org/rest.html
To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html
=============================
The title of your blueprint
=============================
Include the URL of your launchpad blueprint:
https://blueprints.launchpad.net/tempest/+spec/example
Introduction paragraph -- why are we doing anything?
Problem description
===================
A detailed description of the problem.
Proposed change
===============
Here is where you cover the change you propose to make in detail. How do you
propose to solve this problem?
If this is one part of a larger effort make it clear where this piece ends. In
other words, what's the scope of this effort?
Include where in the tempest tree hierarchy this will reside.
If the change is designed to test other OpenStack projects then list which ones
it is targeted at.
Alternatives
------------
This is an optional section which applies if the blueprint covers
infrastructure changes to tempest. For example, blueprints which are
just adding more API tests can leave this section empty.
Where it does apply we'd just like a demonstration that some thought
has been put into why the proposed approach is the best one.
Implementation
==============
Assignee(s)
-----------
Who is leading the writing of the code? Or is this a blueprint where you're
throwing it out there to see who picks it up?
If more than one person is working on the implementation, please designate the
primary author and contact.
Primary assignee:
<launchpad-id or None>
Can optionally can list additional ids if they intend on doing
substantial implementation work on this blueprint.
Milestones
----------
Target Milestone for completion:
Juno-1
Work Items
----------
Work items or tasks -- break the feature up into the things that need to be
done to implement it. Those parts might end up being done by different people,
but we're mostly trying to understand the timeline for implementation.
Dependencies
============
- Include specific references to specs and/or blueprints in tempest, or in other
projects, that this one either depends on or is related to.
- Does this feature require any new library dependencies or code otherwise not
included in OpenStack? Or does it depend on a specific version of library?