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

Create specs directory for Train Change-Id: I4225e37b889bf1a26d6d3ba197e524d3863c472e

2019年01月11日 10:36:19 +09:00

priorities/train-priorities

Create specs directory for Stein Change-Id: I5aaa7d215491eba648862c61f597e78f6246eea7

2018年06月06日 09:24:07 +09:00

priorities/stein-priorities

Create specs directory for Rocky Change-Id: I9cd0237d79398e30a423be6a01f05f146d642c04

2017年10月23日 10:54:35 +09:00

priorities/rocky-priorities

Create specs directory for Queens Change-Id: I1fdf7b1e4fc14a883455a1052c4a502760844b08

2017年04月05日 17:14:07 +01:00

priorities/queens-priorities

Create specs directory for Pike The deadline for non-priority specs for Ocata has passed. Create the Pike spec directories, such that folks can re-target their spec now for review during the Pike cycle. Change-Id: Ic4c13200b0418668f22ec0e4338b4f09d326abe0

2016年12月01日 14:10:09 +00:00

priorities/pike-priorities

Create specs directory for Ocata The deadline for non-priority specs for Newton is almost here, and as always there will be a large number of specs that do not get approved. Any that remain in the Newton directory will eventually get force abandoned. Opening up the Ocata directory allows submitters who wish to re-target their effort to the subsequent release, to move their spec across to the new directory straight away enabling ongoing visibility & review. Change-Id: I732576bb3c0e60ec130cdf73647fbc2f234905f7 Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

2016年06月02日 13:06:33 +01:00

priorities/ocata-priorities

Fix nova-specs priorities references The glob stanzas seem to not want .rst extension on includes. Drop it, and the priorities list returns into the main index. Change-Id: I8e6213425b602d2545cd6dbfc01bde7ea4bafd8c

2016年03月29日 13:51:08 -04:00

priorities/newton-priorities

priorities/mitaka-priorities

priorities/liberty-priorities

priorities/kilo-priorities

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

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

Create specs directory for Train Change-Id: I4225e37b889bf1a26d6d3ba197e524d3863c472e

2019年01月11日 10:36:19 +09:00

specs/train/index

Create specs directory for Stein Change-Id: I5aaa7d215491eba648862c61f597e78f6246eea7

2018年06月06日 09:24:07 +09:00

specs/stein/index

Create specs directory for Rocky Change-Id: I9cd0237d79398e30a423be6a01f05f146d642c04

2017年10月23日 10:54:35 +09:00

specs/rocky/index

Create specs directory for Queens Change-Id: I1fdf7b1e4fc14a883455a1052c4a502760844b08

2017年04月05日 17:14:07 +01:00

specs/queens/index

Create specs directory for Pike The deadline for non-priority specs for Ocata has passed. Create the Pike spec directories, such that folks can re-target their spec now for review during the Pike cycle. Change-Id: Ic4c13200b0418668f22ec0e4338b4f09d326abe0

2016年12月01日 14:10:09 +00:00

specs/pike/index

Create specs directory for Ocata The deadline for non-priority specs for Newton is almost here, and as always there will be a large number of specs that do not get approved. Any that remain in the Newton directory will eventually get force abandoned. Opening up the Ocata directory allows submitters who wish to re-target their effort to the subsequent release, to move their spec across to the new directory straight away enabling ongoing visibility & review. Change-Id: I732576bb3c0e60ec130cdf73647fbc2f234905f7 Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

2016年06月02日 13:06:33 +01:00

specs/ocata/index

Open specs for Newton Now we have the name for newton, we should open specs so people can start targeting changes, either new or deferrals from Mitaka. Change-Id: I84322ba6315316bf3d4ad3923067c5c8e7a9461e

2016年01月20日 11:52:30 +00:00

specs/newton/index

Open specs for Mitaka As discussed at the Liberty mid-cycle, we should open the Mitaka specs so that people can start targeting changes, either new or deferrals from Liberty. Change-Id: I6fe26e5665dcfd4e1a7fc6c0f7b7a9532e825640

2015年07月23日 13:12:03 -07:00

specs/mitaka/index

Open Liberty specs. Opening Liberty specs now allows us to let people move their unapproved Kilo specs to Liberty and start working on our comments now. Change-Id: I7f8391c20ced6fb09b453a8ce3987d141b643a35

2015年01月28日 08:08:09 +11:00

specs/liberty/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

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

Explain how to adopt a backlog spec Now that we are starting to get backlog specs, make it clear how one can take it over and implement it. * Make it clear on the landing page that backlog specs are looking for owners. Hopefully this will guide developers looking for a spec to work in to the right place. * Explain how to take over a backlog spec. Change-Id: Ia3585c515c115e073c00e3222fc6718da79792b9

2015年05月14日 10:14:25 -07:00

There are also some approved backlog specifications that are looking for owners:

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

.. toctree::

:glob:

:maxdepth: 1

specs/backlog/index

Tools & docs for backlog & abandoned spec process Adds tooling and enhances README documentation around the backlog specs process. - To move a spec from the backlog to the current release, we can now use the ``move-spec`` tox target, e.g. tox -e move-spec -- [-n] [-v] specs/backlog/approved/great-idea.rst specs/train/approved - To abandon a backlog spec - i.e. move it from specs/backlog/approved to the (new) specs/abandoned directory, we can now use the ``abandon-spec`` tox target, e.g. tox -e abandon-spec -- [-n] [-v] specs/backlog/it-was-a-great-idea.rst These utilities will move the specified spec into the target directory and create an appropriate redirect for it. To make it so, this commit factors out a helper method that a) moves a spec from one subdirectory to another and b) adds a redirect for it. This is used by the existing ``move-implemented-specs`` utility as well as the new ``move-spec`` and ``abandon-spec``. While I was in here, I spruced up the verbose output (including for move-implemented-specs) to be a bit more readable. Change-Id: I322eecbacd5dc52accf6ac69c9fe1116be8c216f

2019年03月29日 16:39:53 -05:00

Abandoned specs live here:

.. toctree::

:glob:

:maxdepth: 1

specs/abandoned/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

82 lines

1.5 KiB

ReStructuredText

Raw Normal View History

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

82 lines 1.5 KiB ReStructuredText Raw Normal View History Unescape Escape

82 lines

1.5 KiB

ReStructuredText

Raw Normal View History