summaryrefslogtreecommitdiff
path: root/doc/specs
diff options
context:
space:
mode:
authorBoris Pavlovic <boris@pavlovic.me>2015-11-08 20:32:16 -0800
committerBoris Pavlovic <boris@pavlovic.me>2015-11-08 20:34:35 -0800
commit51761f375189bdc03b7e72a266ad0950777f32b1 (patch)
tree83bad50b146bdd701e921da9dd2e294bc6605edb /doc/specs
parentb3011ad24a74e59c359f1e5359e7296f02e06824 (diff)
downloadosprofiler-51761f375189bdc03b7e72a266ad0950777f32b1.tar.gz
Add specs base structure
This patch adds base structure for specs Change-Id: Ie9da0b6070f16d6b78bd06aa44f0da2aad23dd5e
Diffstat (limited to 'doc/specs')
-rw-r--r--doc/specs/README.rst11
-rw-r--r--doc/specs/implemented/README.rst8
-rw-r--r--doc/specs/in-progress/README.rst9
-rw-r--r--doc/specs/template.rst78
4 files changed, 106 insertions, 0 deletions
diff --git a/doc/specs/README.rst b/doc/specs/README.rst
new file mode 100644
index 0000000..3c22dd3
--- /dev/null
+++ b/doc/specs/README.rst
@@ -0,0 +1,11 @@
+OSProfiler Specs
+================
+
+Specs are detailed description of proposed changes in project. Usually they
+answer on what, why, how to change in project and who is going to work on
+change.
+
+This directory contains 2 subdirectories:
+
+- in-progress - These specs are approved, but they are not implemented yet
+- implemented - Implemented specs archive
diff --git a/doc/specs/implemented/README.rst b/doc/specs/implemented/README.rst
new file mode 100644
index 0000000..6d86ff8
--- /dev/null
+++ b/doc/specs/implemented/README.rst
@@ -0,0 +1,8 @@
+OSprofiler Implemented Specs
+============================
+
+Specs are detailed description of proposed changes in project. Usually they
+answer on what, why, how to change in project and who is going to work on
+change.
+
+This directory contains files with implemented specs, 1 file is 1 spec.
diff --git a/doc/specs/in-progress/README.rst b/doc/specs/in-progress/README.rst
new file mode 100644
index 0000000..b17b7d3
--- /dev/null
+++ b/doc/specs/in-progress/README.rst
@@ -0,0 +1,9 @@
+OSprofiler In-Progress Specs
+============================
+
+Specs are detailed description of proposed changes in project. Usually they
+answer on what, why, how to change in project and who is going to work on
+change.
+
+This directory contains files with accepted by not implemented specs,
+1 file is 1 spec.
diff --git a/doc/specs/template.rst b/doc/specs/template.rst
new file mode 100644
index 0000000..a202654
--- /dev/null
+++ b/doc/specs/template.rst
@@ -0,0 +1,78 @@
+..
+ 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/heat/+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 Spec
+=======================
+
+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 heat tree hierarchy this will reside.
+
+Alternatives
+------------
+
+This is an optional section, 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.
+
+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 heat, 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?
+