From 3659df6e75ae1fdd98d6cd95ac58fd9dc324bf77 Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Thu, 4 Jul 2019 14:50:08 +0100 Subject: [PATCH] Update implemented spec and spec document handling Forbidden aggregates was added in microversion 1.32 (part of Train) and allocation candidates mappings was added in 1.34 so those specs have been moved to implemented. An _extra/.htaccess is added to redirect the approved spec to the implemented spec. If we're experiencing enough volume of specs to warrant automating this, it should be easy to do, but at this point we don't have, nor intend to have, large numbers of specs. While doing that I noticed the management of spec documents can be simplified somewhat by moving placeholders and templates to a non-release specific location. The placeholder can then be used as a symlink when in approved or implemented when those are first created or otherwise empty (an empty directory when doing a table of contents glob is an error so some kind of file is needed). Contribution docs are updated to reflect the location of the template.rst file. The template.rst file is updated to be release generic. Change-Id: Icb886d5062a52bfc757ed7bbe36ed8a63abe1387 --- doc/source/_extra/.htaccess | 2 ++ doc/source/conf.py | 1 + doc/source/contributor/contributing.rst | 5 +++-- doc/source/specs/index.rst | 6 ++++++ doc/source/specs/{train/implemented => }/placeholder.rst | 2 +- .../{train/approved/train-template.rst => template.rst} | 2 +- .../2005297-negative-aggregate-membership.rst | 0 ...vider-request-group-mapping-in-allocation-candidates.rst | 0 8 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 doc/source/_extra/.htaccess rename doc/source/specs/{train/implemented => }/placeholder.rst (93%) rename doc/source/specs/{train/approved/train-template.rst => template.rst} (99%) rename doc/source/specs/train/{approved => implemented}/2005297-negative-aggregate-membership.rst (100%) rename doc/source/specs/train/{approved => implemented}/placement-resource-provider-request-group-mapping-in-allocation-candidates.rst (100%) diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess new file mode 100644 index 000000000..0fd4b16bb --- /dev/null +++ b/doc/source/_extra/.htaccess @@ -0,0 +1,2 @@ +redirectmatch 301 ^/placement/([^/]+)/specs/train/approved/2005297-negative-aggregate-membership.html /placement/$1/specs/train/implemented/2005297-negative-aggregate-membership.html +redirectmatch 301 ^/placement/([^/]+)/specs/train/approved/placement-resource-provider-request-group-mapping-in-allocation-candidates.html /placement/$1/specs/train/implemented/placement-resource-provider-request-group-mapping-in-allocation-candidates.html diff --git a/doc/source/conf.py b/doc/source/conf.py index 8df16fffa..d5c6addd6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -114,6 +114,7 @@ html_theme = 'openstackdocs' # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_extra_path = ['_extra'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index c36b01c1e..79e56ca02 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -279,8 +279,9 @@ If a spec is required there are some guidelines for creating one: docs/source/specs/train/approved/200056-infinite-resource-classes.rst - More details on how to write a spec are included in a ``template`` file found - in the ``approved`` directory of each release cycle. + More details on how to write a spec are included in a ``template.rst`` file + found in the ``doc/source/specs`` directory. This may be copied to use as the + starting point for a new spec. * Under normal circumstances specs should be proposed near the beginning of a release cycle so there is sufficient time to review the spec and its diff --git a/doc/source/specs/index.rst b/doc/source/specs/index.rst index e9ee05fee..c94a47bbf 100644 --- a/doc/source/specs/index.rst +++ b/doc/source/specs/index.rst @@ -35,3 +35,9 @@ In Progress :glob: train/approved/* + +.. toctree:: + :hidden: + + placeholder.rst + template.rst diff --git a/doc/source/specs/train/implemented/placeholder.rst b/doc/source/specs/placeholder.rst similarity index 93% rename from doc/source/specs/train/implemented/placeholder.rst rename to doc/source/specs/placeholder.rst index b26f45e25..8d6992873 100644 --- a/doc/source/specs/train/implemented/placeholder.rst +++ b/doc/source/specs/placeholder.rst @@ -16,4 +16,4 @@ Placeholder =========== This is a placeholder document until the first specification has been -implemented. +created in approved or moved to implemented. diff --git a/doc/source/specs/train/approved/train-template.rst b/doc/source/specs/template.rst similarity index 99% rename from doc/source/specs/train/approved/train-template.rst rename to doc/source/specs/template.rst index a37482920..edac0e2a6 100644 --- a/doc/source/specs/train/approved/train-template.rst +++ b/doc/source/specs/template.rst @@ -342,5 +342,5 @@ understand how the spec has changed over time. * - Release Name - Description - * - Train + * - - Introduced diff --git a/doc/source/specs/train/approved/2005297-negative-aggregate-membership.rst b/doc/source/specs/train/implemented/2005297-negative-aggregate-membership.rst similarity index 100% rename from doc/source/specs/train/approved/2005297-negative-aggregate-membership.rst rename to doc/source/specs/train/implemented/2005297-negative-aggregate-membership.rst diff --git a/doc/source/specs/train/approved/placement-resource-provider-request-group-mapping-in-allocation-candidates.rst b/doc/source/specs/train/implemented/placement-resource-provider-request-group-mapping-in-allocation-candidates.rst similarity index 100% rename from doc/source/specs/train/approved/placement-resource-provider-request-group-mapping-in-allocation-candidates.rst rename to doc/source/specs/train/implemented/placement-resource-provider-request-group-mapping-in-allocation-candidates.rst