Revisit the structure of the specs repo

Instead of having a per-release backlog directory, create a top level one that holds the last release backlog. In a healthy project this directory is really meant to be empty or only temporary filled. For specs that are two releases older, the content will be moved to an 'archive' directory, purely for the record. Hopefully this one too will be empty. API and Juno incubator were moved to a miscellanea directory to finish off the cleanup. Finally, some blueprints completed and therefore were moved to the Liberty directory. Change-Id: I972a9a56c038864d9c91ead6944c6b9355916668
openstack · Oct 28, 2015 · 415f1ea · 415f1ea
1 parent 19a153a
commit 415f1ea
Show file tree

Hide file tree

Showing 63 changed files with 19 additions and 745 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -77,6 +77,7 @@
     '**/example.rst',
     '**/template.rst',
     '**/skeleton.rst',
+    '**/archive',
 ]
 
 # The reST default role (used for this markup: `text`) to use for all documents.

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -4,78 +4,50 @@
 Neutron Project Specifications
 ==============================
 
-Mitaka approved specs
-=====================
+Mitaka
+======
 
 .. toctree::
    :glob:
    :maxdepth: 1
 
    specs/mitaka/*
 
-Liberty approved specs
-======================
+Liberty
+=======
 
 .. toctree::
    :glob:
    :maxdepth: 1
 
    specs/liberty/*
 
-Kilo approved specs
-===================
+Kilo
+====
 
 .. toctree::
    :glob:
    :maxdepth: 1
 
    specs/kilo/*
 
-Liberty backlog specs
-=====================
-
-.. toctree::
-   :glob:
-   :maxdepth: 1
-
-   specs/liberty-backlog/*
-
-Kilo backlog specs
-===================
-
-.. toctree::
-   :glob:
-   :maxdepth: 1
-
-   specs/kilo-backlog/*
-
-Juno approved specs
-===================
+Juno
+====
 
 .. toctree::
    :glob:
    :maxdepth: 1
 
    specs/juno/*
 
-API specs
-=========
-
-.. toctree::
-   :glob:
-   :maxdepth: 1
-
-   specs/api/*
-
-
-Neutron Incubator
------------------
+Backlog
+=======
 
 .. toctree::
    :glob:
    :maxdepth: 1
 
-   specs/juno-incubator/*
+   specs/backlog/**
 
 ==================
 Indices and tables

diff --git a/specs/api/agent_management.rst → misc/api/agent_management.rst b/specs/api/agent_management.rst → misc/api/agent_management.rst
diff --git a/specs/api/agent_schedulers.rst → misc/api/agent_schedulers.rst b/specs/api/agent_schedulers.rst → misc/api/agent_schedulers.rst
diff --git a/specs/api/allowed_address_pairs.rst → misc/api/allowed_address_pairs.rst b/specs/api/allowed_address_pairs.rst → misc/api/allowed_address_pairs.rst
diff --git a/...i/configurable_external_gateway_modes.rst → ...i/configurable_external_gateway_modes.rst b/...i/configurable_external_gateway_modes.rst → ...i/configurable_external_gateway_modes.rst
diff --git a/.../api/external_networks__external-net_.rst → .../api/external_networks__external-net_.rst b/.../api/external_networks__external-net_.rst → .../api/external_networks__external-net_.rst
diff --git a/...i/extra_dhcp_options__extra-dhcp-opt_.rst → ...i/extra_dhcp_options__extra-dhcp-opt_.rst b/...i/extra_dhcp_options__extra-dhcp-opt_.rst → ...i/extra_dhcp_options__extra-dhcp-opt_.rst
diff --git a/specs/api/extra_routes.rst → misc/api/extra_routes.rst b/specs/api/extra_routes.rst → misc/api/extra_routes.rst
diff --git a/specs/api/firewall_as_a_service__fwaas_.rst → misc/api/firewall_as_a_service__fwaas_.rst b/specs/api/firewall_as_a_service__fwaas_.rst → misc/api/firewall_as_a_service__fwaas_.rst
diff --git a/specs/api/layer-3_networking.rst → misc/api/layer-3_networking.rst b/specs/api/layer-3_networking.rst → misc/api/layer-3_networking.rst
diff --git a/...pi/load-balancer-as-a-service__lbaas_.rst → ...pi/load-balancer-as-a-service__lbaas_.rst b/...pi/load-balancer-as-a-service__lbaas_.rst → ...pi/load-balancer-as-a-service__lbaas_.rst
diff --git a/specs/api/metering_labels_and_rules.rst → misc/api/metering_labels_and_rules.rst b/specs/api/metering_labels_and_rules.rst → misc/api/metering_labels_and_rules.rst
diff --git a/specs/api/multiple_provider_networks.rst → misc/api/multiple_provider_networks.rst b/specs/api/multiple_provider_networks.rst → misc/api/multiple_provider_networks.rst
diff --git a/specs/api/networking_api_overview.rst → misc/api/networking_api_overview.rst b/specs/api/networking_api_overview.rst → misc/api/networking_api_overview.rst
diff --git a/...pi/networking_general_api_information.rst → ...pi/networking_general_api_information.rst b/...pi/networking_general_api_information.rst → ...pi/networking_general_api_information.rst
diff --git a/specs/api/ports.rst → misc/api/ports.rst b/specs/api/ports.rst → misc/api/ports.rst
diff --git a/...s_binding_extended_attributes__ports_.rst → ...s_binding_extended_attributes__ports_.rst b/...s_binding_extended_attributes__ports_.rst → ...s_binding_extended_attributes__ports_.rst
diff --git a/specs/api/provider_networks__provider_.rst → misc/api/provider_networks__provider_.rst b/specs/api/provider_networks__provider_.rst → misc/api/provider_networks__provider_.rst
diff --git a/specs/api/quotas.rst → misc/api/quotas.rst b/specs/api/quotas.rst → misc/api/quotas.rst
diff --git a/...ty_groups_and_rules__security-groups_.rst → ...ty_groups_and_rules__security-groups_.rst b/...ty_groups_and_rules__security-groups_.rst → ...ty_groups_and_rules__security-groups_.rst
diff --git a/specs/api/subnets.rst → misc/api/subnets.rst b/specs/api/subnets.rst → misc/api/subnets.rst
diff --git a/...private_network_as_a_service__vpnaas_.rst → ...private_network_as_a_service__vpnaas_.rst b/...private_network_as_a_service__vpnaas_.rst → ...private_network_as_a_service__vpnaas_.rst
diff --git a/specs/juno-incubator/example.rst → misc/juno-incubator/example.rst b/specs/juno-incubator/example.rst → misc/juno-incubator/example.rst
diff --git a/...or/lbaas-api-and-objmodel-improvement.rst → ...or/lbaas-api-and-objmodel-improvement.rst b/...or/lbaas-api-and-objmodel-improvement.rst → ...or/lbaas-api-and-objmodel-improvement.rst
diff --git a/specs/juno-incubator/lbaas-l7-rules.rst → misc/juno-incubator/lbaas-l7-rules.rst b/specs/juno-incubator/lbaas-l7-rules.rst → misc/juno-incubator/lbaas-l7-rules.rst
diff --git a/...o-incubator/lbaas-ref-driver-impl-tls.rst → ...o-incubator/lbaas-ref-driver-impl-tls.rst b/...o-incubator/lbaas-ref-driver-impl-tls.rst → ...o-incubator/lbaas-ref-driver-impl-tls.rst
diff --git a/...espace-driver-to-new-driver-interface.rst → ...espace-driver-to-new-driver-interface.rst b/...espace-driver-to-new-driver-interface.rst → ...espace-driver-to-new-driver-interface.rst
diff --git a/specs/juno-incubator/lbaas-tls.rst → misc/juno-incubator/lbaas-tls.rst b/specs/juno-incubator/lbaas-tls.rst → misc/juno-incubator/lbaas-tls.rst
diff --git a/...s/juno-incubator/radware-lbaas-driver.rst → misc/juno-incubator/radware-lbaas-driver.rst b/...s/juno-incubator/radware-lbaas-driver.rst → misc/juno-incubator/radware-lbaas-driver.rst
diff --git a/specs/archive/README b/specs/archive/README
@@ -0,0 +1,3 @@
+If X is the current release, this contains any spec that did not
+complete in X-2 (or older), and was not moved forward. Ideally
+this directory would be empty.
diff --git a/...ilo-backlog/extra-dhcp-opts-ipv4-ipv6.rst → ...rchive/kilo/extra-dhcp-opts-ipv4-ipv6.rst b/...ilo-backlog/extra-dhcp-opts-ipv4-ipv6.rst → ...rchive/kilo/extra-dhcp-opts-ipv4-ipv6.rst
diff --git a/...s/kilo-backlog/guru-meditation-report.rst → ...s/archive/kilo/guru-meditation-report.rst b/...s/kilo-backlog/guru-meditation-report.rst → ...s/archive/kilo/guru-meditation-report.rst
diff --git a/specs/kilo-backlog/iptables-driver.rst → specs/archive/kilo/iptables-driver.rst b/specs/kilo-backlog/iptables-driver.rst → specs/archive/kilo/iptables-driver.rst
diff --git a/.../kilo-backlog/migration-from-nova-net.rst → .../archive/kilo/migration-from-nova-net.rst b/.../kilo-backlog/migration-from-nova-net.rst → .../archive/kilo/migration-from-nova-net.rst
diff --git a/...cklog/ml2-cisco-nexus-md-prov-segment.rst → .../kilo/ml2-cisco-nexus-md-prov-segment.rst b/...cklog/ml2-cisco-nexus-md-prov-segment.rst → .../kilo/ml2-cisco-nexus-md-prov-segment.rst
diff --git a/specs/kilo-backlog/ofagent-bridge-setup.rst → specs/archive/kilo/ofagent-bridge-setup.rst b/specs/kilo-backlog/ofagent-bridge-setup.rst → specs/archive/kilo/ofagent-bridge-setup.rst
diff --git a/specs/kilo-backlog/ofagent-sub-driver.rst → specs/archive/kilo/ofagent-sub-driver.rst b/specs/kilo-backlog/ofagent-sub-driver.rst → specs/archive/kilo/ofagent-sub-driver.rst
diff --git a/...-backlog/plugin-interface-perestroika.rst → ...ive/kilo/plugin-interface-perestroika.rst b/...-backlog/plugin-interface-perestroika.rst → ...ive/kilo/plugin-interface-perestroika.rst
diff --git a/...s/kilo-backlog/pydev-debugger-support.rst → ...s/archive/kilo/pydev-debugger-support.rst b/...s/kilo-backlog/pydev-debugger-support.rst → ...s/archive/kilo/pydev-debugger-support.rst
diff --git a/...cklog/retargetable-functional-testing.rst → .../kilo/retargetable-functional-testing.rst b/...cklog/retargetable-functional-testing.rst → .../kilo/retargetable-functional-testing.rst
diff --git a/specs/kilo-backlog/vmware-lbaas-v2.rst → specs/archive/kilo/vmware-lbaas-v2.rst b/specs/kilo-backlog/vmware-lbaas-v2.rst → specs/archive/kilo/vmware-lbaas-v2.rst
diff --git a/specs/backlog/README b/specs/backlog/README
@@ -0,0 +1,2 @@
+If X is the current release, this contains any spec that did not
+complete in X-1. Ideally this directory would be empty.
diff --git a/specs/liberty-backlog/add-port-timestamp.rst → specs/backlog/liberty/add-port-timestamp.rst b/specs/liberty-backlog/add-port-timestamp.rst → specs/backlog/liberty/add-port-timestamp.rst
diff --git a/...berty-backlog/adopt-oslo-guru-reports.rst → ...cklog/liberty/adopt-oslo-guru-reports.rst b/...berty-backlog/adopt-oslo-guru-reports.rst → ...cklog/liberty/adopt-oslo-guru-reports.rst
diff --git a/specs/liberty-backlog/decompose-aas.rst → specs/backlog/liberty/decompose-aas.rst b/specs/liberty-backlog/decompose-aas.rst → specs/backlog/liberty/decompose-aas.rst
diff --git a/specs/liberty-backlog/dmvpn.rst → specs/backlog/liberty/dmvpn.rst b/specs/liberty-backlog/dmvpn.rst → specs/backlog/liberty/dmvpn.rst
diff --git a/specs/liberty-backlog/lbaas-l7-rules.rst → specs/backlog/liberty/lbaas-l7-rules.rst b/specs/liberty-backlog/lbaas-l7-rules.rst → specs/backlog/liberty/lbaas-l7-rules.rst
diff --git a/specs/liberty-backlog/microversioning.rst → specs/backlog/liberty/microversioning.rst b/specs/liberty-backlog/microversioning.rst → specs/backlog/liberty/microversioning.rst
diff --git a/specs/liberty-backlog/neutron-lib.rst → specs/backlog/liberty/neutron-lib.rst b/specs/liberty-backlog/neutron-lib.rst → specs/backlog/liberty/neutron-lib.rst
diff --git a/specs/liberty-backlog/reference-split.rst → specs/backlog/liberty/reference-split.rst b/specs/liberty-backlog/reference-split.rst → specs/backlog/liberty/reference-split.rst
diff --git a/specs/liberty-backlog/service-group.rst → specs/backlog/liberty/service-group.rst b/specs/liberty-backlog/service-group.rst → specs/backlog/liberty/service-group.rst
diff --git a/...liberty-backlog/stateless-floatingips.rst → ...backlog/liberty/stateless-floatingips.rst b/...liberty-backlog/stateless-floatingips.rst → ...backlog/liberty/stateless-floatingips.rst
diff --git a/specs/juno/example.rst b/specs/juno/example.rst
diff --git a/specs/kilo/dummy.rst b/specs/kilo/dummy.rst
diff --git a/specs/kilo/example.rst b/specs/kilo/example.rst
diff --git a/...ilo-backlog/reorganize-unit-test-tree.rst → specs/kilo/reorganize-unit-test-tree.rst b/...ilo-backlog/reorganize-unit-test-tree.rst → specs/kilo/reorganize-unit-test-tree.rst
diff --git a/...-backlog/arp-spoof-filtering-ebtables.rst → .../liberty/arp-spoof-filtering-ebtables.rst b/...-backlog/arp-spoof-filtering-ebtables.rst → .../liberty/arp-spoof-filtering-ebtables.rst
diff --git a/specs/kilo-backlog/better-quotas.rst → specs/liberty/better-quotas.rst b/specs/kilo-backlog/better-quotas.rst → specs/liberty/better-quotas.rst
diff --git a/specs/liberty/dummy.rst b/specs/liberty/dummy.rst