From 912ae3086a039631cf40cb24a92cb1bda79ee918 Mon Sep 17 00:00:00 2001 From: Lars Kellogg-Stedman Date: Fri, 26 Aug 2016 12:17:09 -0400 Subject: [PATCH] create ocata spec template and directory Change-Id: Id28f0ee290dbc74591e0a1b0228ac36d29b06a1b --- doc/source/index.rst | 8 +++ specs/ocata/ocata-template.rst | 1 + specs/templates/ocata-template.rst | 95 ++++++++++++++++++++++++++++++ 3 files changed, 104 insertions(+) create mode 120000 specs/ocata/ocata-template.rst create mode 100644 specs/templates/ocata-template.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 058b6e08..766839d6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -41,6 +41,14 @@ Newton specs/newton/* +Ocata +------ +.. toctree:: + :glob: + :maxdepth: 1 + + specs/ocata/* + heat-specs Repository Information ================================= diff --git a/specs/ocata/ocata-template.rst b/specs/ocata/ocata-template.rst new file mode 120000 index 00000000..5ac35ee5 --- /dev/null +++ b/specs/ocata/ocata-template.rst @@ -0,0 +1 @@ +../templates/ocata-template.rst \ No newline at end of file diff --git a/specs/templates/ocata-template.rst b/specs/templates/ocata-template.rst new file mode 100644 index 00000000..d1f97144 --- /dev/null +++ b/specs/templates/ocata-template.rst @@ -0,0 +1,95 @@ +.. + 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 blueprint +=========================== + +Include the URL of your launchpad blueprint: + +https://blueprints.launchpad.net/heat/+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 heat tree hierarchy this will reside. + +If your specification proposes any changes to the Heat REST API such +as changing parameters which can be returned or accepted, or even +the semantics of what happens when a client calls into the API, then +you should add the APIImpact flag to the commit message. Specifications with +the APIImpact flag can be found with the following query: + +https://review.openstack.org/#/q/status:open+project:openstack/heat-specs+message:apiimpact,n,z + +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: + + +Can optionally can list additional ids if they intend on doing +substantial implementation work on this blueprint. + +Milestones +---------- + +Target Milestone for completion: + ocata-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 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?