Add specs directory to OpenStack-Helm

Adds the specs/ directory to openstack-helm for housing future
specifications for the project.  It also includes an appropriate
README with directions for drafting specs, links to the openstack
resources for bp+spec lifecycle, and a template for use in
drafting specifications

Change-Id: Ice23447b358b520a8b4fb703fc836e8f09fa34d1
This commit is contained in:
Steve Wilkerson 2017-07-11 12:25:14 -05:00
parent ed2bca3370
commit 7279be8b85
4 changed files with 120 additions and 5 deletions

View File

@ -11,13 +11,14 @@ Contents:
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
readme
install/index
devref/index
contributing contributing
troubleshooting/index devref/index
testing
gates gates
install/index
readme
specs/index
testing
troubleshooting/index
Indices and tables Indices and tables
================== ==================

View File

@ -0,0 +1,10 @@
Specifications
==============
Contents:
.. toctree::
:maxdepth: 2
specifications.rst
template.rst

View File

@ -0,0 +1,33 @@
=====================
Project Specfications
=====================
Specifications in this repository represent a consensus on the topics covered
within. They should be considered a mandate on the path forward with regards
to the content on which they are drafted.
Purpose
-------
A specification should precede any broad-reaching technical changes or proposals
to OpenStack-Helm. Examples of changes requiring a specification include: a
standard format to the values.yaml files, multiple backend support for neutron,
and the approach for logging and monitoring in OpenStack-Helm. Some additional
features will not need an accompanying specification, but may be tied back to an
existing specification. An example of this would be introducing a service in
OpenStack-Helm that could be included under the scope of a specification already
drafted and approved.
Process
-------
Before drafting a specification, a blueprint should be filed in Launchpad_ along
with any dependencies the blueprint requires. Once the blueprint has been
registered, submit the specification as a patch set to the specs/ directory
using the supplied template.
More information about the blueprint + specification lifecycle can be found
here_.
.. _Launchpad: https://blueprints.launchpad.net/openstack-helm
.. _here: https://wiki.openstack.org/wiki/Blueprints#Blueprints_and_Specs

View File

@ -0,0 +1,71 @@
..
This work is licensed under a Creative Commons Attribution 3.0 Unported
License.
http://creativecommons.org/licenses/by/3.0/legalcode
..
===============
Blueprint Title
===============
Include the URL of your Launchpad blueprint:
https://blueprints.launchpad.net/openstack-helm/+spec/example
Problem Description
===================
A detailed description of the problem.
Use cases
---------
1. TODO
Proposed Change
===============
How do you propose to solve this problem, and what's the scope?
Security Impact
---------------
How does this feature impact the securtiy of OpenStack-Helm?
Performance Impact
------------------
Does this feature impact the performance of OpenStack-Helm?
Alternatives
------------
Why is the proposed approach the best approach?
Implementation
==============
Assignee(s)
-----------
Who is leading the implementation?
Designate the primary author and contact.
Primary assignee:
<launchpad-id or None>
Work Items
----------
Work items or tasks. These can be worked on by multiple contributors.
Testing
=======
What tests will verify this change is functional?
Documentation Impact
====================
What documentation needs must be considered with this change?
References
==========
Place any external references here.