Fix Table of Contents and add Kilo spec location
Added a kilo directory for specs for Kilo. Also fixed the Table of contents. Co-Authored-By: Nikhil Manchanda <SlickNik@gmail.com> Change-Id: I7cc337c4f290eec68baad73b730bc05af48c7423
This commit is contained in:
Denis Makogon
Nikhil Manchanda
parent
db9d439bb9
commit
0ce8d353a4
@ -6,8 +6,3 @@ OpenStack Database Service (Trove) Specifications
|
|||||||
|
|
||||||
* Free software: Apache license
|
* Free software: Apache license
|
||||||
* Documentation: http://docs.openstack.org/developer/trove-specs
|
* Documentation: http://docs.openstack.org/developer/trove-specs
|
||||||
|
|
||||||
Features
|
|
||||||
--------
|
|
||||||
|
|
||||||
* TODO
|
|
||||||
@ -1,29 +1,36 @@
|
|||||||
.. trove-specs documentation master file, created by
|
.. trove-specs documentation master file
|
||||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
trove-specs Design Specifications
|
============================
|
||||||
==================================================
|
Trove Project Specifications
|
||||||
|
============================
|
||||||
|
|
||||||
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
specs/*
|
specs/*
|
||||||
|
|
||||||
|
Kilo approved specs:
|
||||||
|
|
||||||
trove-specs Repository Information
|
.. toctree::
|
||||||
===================================================
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/kilo/*
|
||||||
|
|
||||||
|
======================
|
||||||
|
Repository Information
|
||||||
|
======================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
README <readme>
|
README <readme>
|
||||||
contributing
|
contributing
|
||||||
Sample Template <template>
|
|
||||||
|
|
||||||
|
|
||||||
|
==================
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
|||||||
@ -1,87 +0,0 @@
|
|||||||
..
|
|
||||||
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/trove/+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//+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 trove 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.
|
|
||||||
|
|
||||||
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 trove, 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?
|
|
||||||
0
specs/kilo/.gitignore
vendored
Normal file
0
specs/kilo/.gitignore
vendored
Normal file
3
specs/kilo/placeholder.rst
Normal file
3
specs/kilo/placeholder.rst
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
======================
|
||||||
|
Placeholder Kilo Specs
|
||||||
|
======================
|
||||||
86
template.rst
86
template.rst
@ -1,86 +0,0 @@
|
|||||||
::
|
|
||||||
|
|
||||||
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/trove/+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//+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 trove 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.
|
|
||||||
|
|
||||||
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 trove, 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?
|
|
||||||
Loading…
x
Reference in New Issue
Block a user