nova-specs

Make nova-specs an oslosphinx project Update the nova-specs project to use sphinx. This will allow us to still write our specs using rst, but also have a nice framework for rendering and publishing the specs if we choose to. Change-Id: Ib92231acb28bba44abafb7dd554404f542da13a7

2014年03月24日 13:29:39 -04:00

.. nova-specs documentation master file

Separate kilo and juno specs Need to split out the different releases so the index page will continue to scale past the current two releases. It required some rework how the specs are symlinked into the doc source to allow for the release specific landing pages. Change-Id: I31fa0b13e400dd202f5db3e63da7b7c8dbd40e68

2014年11月11日 10:37:16 +00:00

============================

OpenStack Nova Project Plans

============================

Priorities

==========

During each design summit, we agree what the whole community wants to focus

on for the upcoming release. This is the output of those discussions:

Add in concept of project priorities * Add section in kilo-template about project priorities (with a link to the kilo priorities document) * Add in kilo priorities page. Currently this list is empty and we hope to fill it out at the summit * Add the yaml file of priority blueprints that are ready for review. This is where we will track which priority blueprints need review. Change-Id: I339e88f8055a63a9a9423d997da6581f977428c9

2014年09月30日 17:21:09 -07:00

.. toctree::

:glob:

:maxdepth: 1

priorities/*

Separate kilo and juno specs Need to split out the different releases so the index page will continue to scale past the current two releases. It required some rework how the specs are symlinked into the doc source to allow for the release specific landing pages. Change-Id: I31fa0b13e400dd202f5db3e63da7b7c8dbd40e68

2014年11月11日 10:37:16 +00:00

Specifications

==============

Add in concept of project priorities * Add section in kilo-template about project priorities (with a link to the kilo priorities document) * Add in kilo priorities page. Currently this list is empty and we hope to fill it out at the summit * Add the yaml file of priority blueprints that are ready for review. This is where we will track which priority blueprints need review. Change-Id: I339e88f8055a63a9a9423d997da6581f977428c9

2014年09月30日 17:21:09 -07:00

Separate kilo and juno specs Need to split out the different releases so the index page will continue to scale past the current two releases. It required some rework how the specs are symlinked into the doc source to allow for the release specific landing pages. Change-Id: I31fa0b13e400dd202f5db3e63da7b7c8dbd40e68

2014年11月11日 10:37:16 +00:00

Here you can find the specs, and spec template, for each release:

Make nova-specs an oslosphinx project Update the nova-specs project to use sphinx. This will allow us to still write our specs using rst, but also have a nice framework for rendering and publishing the specs if we choose to. Change-Id: Ib92231acb28bba44abafb7dd554404f542da13a7

2014年03月24日 13:29:39 -04:00

.. toctree::

:glob:

Make index.rst usable * Update to reflect new directory structure * Drop maxdepth to 1, to make the page smaller, otherwise the index will include links to each section of each blueprint. And since each section will have the same name across bluepints this is useless. Change-Id: I2a5d94ae26002a884033d27881394a795592fe3f

2014年03月27日 15:54:35 -07:00

:maxdepth: 1

Make nova-specs an oslosphinx project Update the nova-specs project to use sphinx. This will allow us to still write our specs using rst, but also have a nice framework for rendering and publishing the specs if we choose to. Change-Id: Ib92231acb28bba44abafb7dd554404f542da13a7

2014年03月24日 13:29:39 -04:00

Separate kilo and juno specs Need to split out the different releases so the index page will continue to scale past the current two releases. It required some rework how the specs are symlinked into the doc source to allow for the release specific landing pages. Change-Id: I31fa0b13e400dd202f5db3e63da7b7c8dbd40e68

2014年11月11日 10:37:16 +00:00

specs/kilo/index

specs/juno/index

Re-organize juno specs As discussed at our nova meetings, reorganize the juno specs into three directories: - proposed: things proposed which weren't approved - approved: things we approved but didn't implement - implemented: things approved and implemented The first I suspect is the most controversial. I've done this because I worry about the case where a future developer wants to pick up something dropped by a previous developer, but has trouble finding previous proposed specifications on the topic. Note that the actual proposed specs for Juno are adding in a later commit. Change-Id: Idcf55ca37a83d7098dcb7c2971240c4e8fd23dc8

2014年09月17日 17:01:52 +10:00

Add Spec Backlog This is copying what has been done for keystone: If546724fd535db7753a372389c3f90f3b060d9bc We add a place for people to add rough ideas, and a place to put specs that are no longer going to be implemented by the proposer. Includes updating the README to tell people where the backlog specs will live. We need to add a backlog spec before we can complete this change, this is just a placeholder to advertise the backlog idea. Change-Id: I667acfa422ef78bdc80efb279911091116b1c1f0

2014年11月12日 12:08:14 +00:00

There are also some partial specifications that can be found here:

.. toctree::

:glob:

:maxdepth: 1

specs/backlog/index

Separate kilo and juno specs Need to split out the different releases so the index page will continue to scale past the current two releases. It required some rework how the specs are symlinked into the doc source to allow for the release specific landing pages. Change-Id: I31fa0b13e400dd202f5db3e63da7b7c8dbd40e68

2014年11月11日 10:37:16 +00:00

Process

=======

Re-organize juno specs As discussed at our nova meetings, reorganize the juno specs into three directories: - proposed: things proposed which weren't approved - approved: things we approved but didn't implement - implemented: things approved and implemented The first I suspect is the most controversial. I've done this because I worry about the case where a future developer wants to pick up something dropped by a previous developer, but has trouble finding previous proposed specifications on the topic. Note that the actual proposed specs for Juno are adding in a later commit. Change-Id: Idcf55ca37a83d7098dcb7c2971240c4e8fd23dc8

2014年09月17日 17:01:52 +10:00

Separate kilo and juno specs Need to split out the different releases so the index page will continue to scale past the current two releases. It required some rework how the specs are symlinked into the doc source to allow for the release specific landing pages. Change-Id: I31fa0b13e400dd202f5db3e63da7b7c8dbd40e68

2014年11月11日 10:37:16 +00:00

Documentation for nova-specs process:

Add v2-on-v3-api spec Note that this change includes an addition to the doc index which is needed to bootstrap the approved directory for Kilo. Without the change a sphinx warning about the new spec rst file not being included anywhere causes the build to fail. And applying the change with an empty approved directory the pattern match fails and the build fails Previously-approved: juno Part of blueprint v2-on-v3-api Change-Id: Ib8b259f69c9072520acecba167b7b31707bcadaa

2014年10月07日 11:14:07 +10:30

.. toctree::

:maxdepth: 1

Separate kilo and juno specs Need to split out the different releases so the index page will continue to scale past the current two releases. It required some rework how the specs are symlinked into the doc source to allow for the release specific landing pages. Change-Id: I31fa0b13e400dd202f5db3e63da7b7c8dbd40e68

2014年11月11日 10:37:16 +00:00

How to submit a spec <readme>

For more details, look at spec template for the specific release, and see the

wiki page on Blueprints: https://wiki.openstack.org/wiki/Blueprints

Add v2-on-v3-api spec Note that this change includes an addition to the doc index which is needed to bootstrap the approved directory for Kilo. Without the change a sphinx warning about the new spec rst file not being included anywhere causes the build to fail. And applying the change with an empty approved directory the pattern match fails and the build fails Previously-approved: juno Part of blueprint v2-on-v3-api Change-Id: Ib8b259f69c9072520acecba167b7b31707bcadaa

2014年10月07日 11:14:07 +10:30

Make nova-specs an oslosphinx project Update the nova-specs project to use sphinx. This will allow us to still write our specs using rst, but also have a nice framework for rendering and publishing the specs if we choose to. Change-Id: Ib92231acb28bba44abafb7dd554404f542da13a7

2014年03月24日 13:29:39 -04:00

Indices and tables

==================

* :ref:`search`

openstack/nova-specs - nova-specs - OpenDev: Free Software Needs Free Tools

56 lines

989 B

ReStructuredText

Raw Normal View History

openstack/nova-specs - nova-specs - OpenDev: Free Software Needs Free Tools

56 lines 989 B ReStructuredText Raw Normal View History Unescape Escape

56 lines

989 B

ReStructuredText

Raw Normal View History