From 263e1d704a29a75db17c58a0f2f6650c171cdfc5 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Wed, 26 Mar 2014 15:05:59 -0400 Subject: [PATCH] Add a template spec This commit adds a basic template based on the one in the qa-specs repo. It obviously won't be exact for every project but it gives a starting point. --- .../doc/source/index.rst | 1 + .../doc/source/template.rst | 1 + {{cookiecutter.repo_name}}/template.rst | 86 +++++++++++++++++++ 3 files changed, 88 insertions(+) create mode 100644 {{cookiecutter.repo_name}}/doc/source/template.rst create mode 100644 {{cookiecutter.repo_name}}/template.rst diff --git a/{{cookiecutter.repo_name}}/doc/source/index.rst b/{{cookiecutter.repo_name}}/doc/source/index.rst index 85bde1f..4b1762a 100644 --- a/{{cookiecutter.repo_name}}/doc/source/index.rst +++ b/{{cookiecutter.repo_name}}/doc/source/index.rst @@ -20,6 +20,7 @@ :maxdepth: 2 readme contributing + Sample Template Indices and tables diff --git a/{{cookiecutter.repo_name}}/doc/source/template.rst b/{{cookiecutter.repo_name}}/doc/source/template.rst new file mode 100644 index 0000000..b92a6bd --- /dev/null +++ b/{{cookiecutter.repo_name}}/doc/source/template.rst @@ -0,0 +1 @@ +.. include:: ../template.rst diff --git a/{{cookiecutter.repo_name}}/template.rst b/{{cookiecutter.repo_name}}/template.rst new file mode 100644 index 0000000..c16ed1b --- /dev/null +++ b/{{cookiecutter.repo_name}}/template.rst @@ -0,0 +1,86 @@ +:: + +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/{{ cookiecutter.project_name }}/+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/{{ cookiecutter.projcet_name }}/+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 {{ cookiecutter.project_name }} 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: + + +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 {{ cookiecutter.project_name }}, 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?