diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess index 83cb01a952..566b27e8ed 100644 --- a/doc/source/_extra/.htaccess +++ b/doc/source/_extra/.htaccess @@ -1,3 +1,5 @@ -redirectmatch 301 ^/heat/([^/]+)/(architecture|pluginguide|schedulerhints|gmr|supportstatus)\.html$ /heat/$1/developing_guides/$2.html +redirectmatch 301 ^/heat/([^/]+)/(architecture|pluginguide|schedulerhints|gmr|supportstatus)\.html$ /heat/$1/contributor/$2.html +redirectmatch 301 ^/heat/([^/]+)/developing_guides/(index|architecture|pluginguide|schedulerhints|gmr|supportstatus)\.html$ /heat/$1/contributor/$2.html redirectmatch 301 ^/heat/([^/]+)/(scale_deployment)\.html$ /heat/$1/operating_guides/$2.html redirectmatch 301 ^/heat/([^/]+)/configuration/(api|clients)\.html /heat/$1/configuration/config-options.html +redirectmatch 301 ^/heat/([^/]+)/contributing/(index|blueprints)\.html /heat/$1/contributor/$2.html diff --git a/doc/source/contributing/index.rst b/doc/source/contributing/index.rst deleted file mode 100644 index 7acea26b85..0000000000 --- a/doc/source/contributing/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -Heat Contribution Guidelines -============================ - -In the Contributions Guide, you will find documented policies for -developing with heat. This includes the processes we use for -blueprints and specs, bugs, contributor onboarding, core reviewer -memberships, and other procedural items. - -Policies --------- -.. toctree:: - :maxdepth: 3 - - blueprints -.. bugs - contributor-onboarding - core-reviewers - gate-failure-triage - code-reviews diff --git a/doc/source/developing_guides/architecture.rst b/doc/source/contributor/architecture.rst similarity index 100% rename from doc/source/developing_guides/architecture.rst rename to doc/source/contributor/architecture.rst diff --git a/doc/source/contributing/blueprints.rst b/doc/source/contributor/blueprints.rst similarity index 100% rename from doc/source/contributing/blueprints.rst rename to doc/source/contributor/blueprints.rst diff --git a/doc/source/developing_guides/gmr.rst b/doc/source/contributor/gmr.rst similarity index 100% rename from doc/source/developing_guides/gmr.rst rename to doc/source/contributor/gmr.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000000..ac4481fb35 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,26 @@ +Heat Contributor Guidelines +=========================== + +In the contributor guide, you will find documented policies for +developing with heat. This includes the processes we use for +blueprints and specs, bugs, contributor onboarding, core reviewer +memberships, and other procedural items. + +.. note:: This guideline also includes documentation for developers. + +.. toctree:: + :maxdepth: 3 + + ../getting_started/on_devstack + blueprints + architecture + pluginguide + schedulerhints + gmr + supportstatus + rally_on_gates +.. bugs + contributor-onboarding + core-reviewers + gate-failure-triage + code-reviews diff --git a/doc/source/developing_guides/pluginguide.rst b/doc/source/contributor/pluginguide.rst similarity index 100% rename from doc/source/developing_guides/pluginguide.rst rename to doc/source/contributor/pluginguide.rst diff --git a/doc/source/developing_guides/rally_on_gates.rst b/doc/source/contributor/rally_on_gates.rst similarity index 100% rename from doc/source/developing_guides/rally_on_gates.rst rename to doc/source/contributor/rally_on_gates.rst diff --git a/doc/source/developing_guides/schedulerhints.rst b/doc/source/contributor/schedulerhints.rst similarity index 100% rename from doc/source/developing_guides/schedulerhints.rst rename to doc/source/contributor/schedulerhints.rst diff --git a/doc/source/developing_guides/supportstatus.rst b/doc/source/contributor/supportstatus.rst similarity index 100% rename from doc/source/developing_guides/supportstatus.rst rename to doc/source/contributor/supportstatus.rst diff --git a/doc/source/developing_guides/index.rst b/doc/source/developing_guides/index.rst deleted file mode 100644 index 8b29ef4b9b..0000000000 --- a/doc/source/developing_guides/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -:orphan: - -Developing Guides -================= - -.. toctree:: - :maxdepth: 1 - - ../contributing/index - ../getting_started/on_devstack - architecture - pluginguide - schedulerhints - gmr - supportstatus - rally_on_gates diff --git a/doc/source/index.rst b/doc/source/index.rst index 956eaf32de..58426e4c72 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -90,14 +90,14 @@ Developing Heat .. toctree:: :maxdepth: 1 - contributing/index + contributor/index getting_started/on_devstack - developing_guides/architecture - developing_guides/pluginguide - developing_guides/schedulerhints - developing_guides/gmr - developing_guides/supportstatus - developing_guides/rally_on_gates + contributor/architecture + contributor/pluginguide + contributor/schedulerhints + contributor/gmr + contributor/supportstatus + contributor/rally_on_gates api/index Indices and tables diff --git a/doc/source/operating_guides/scale_deployment.rst b/doc/source/operating_guides/scale_deployment.rst index 0e79fab83e..156f591c9b 100644 --- a/doc/source/operating_guides/scale_deployment.rst +++ b/doc/source/operating_guides/scale_deployment.rst @@ -48,9 +48,9 @@ Basic Architecture ------------------ The heat architecture is as defined at :doc:`heat architecture -<../developing_guides/architecture>` and shown in the diagram below, -where we have a CLI that sends HTTP requests to the REST and CFN APIs, which in -turn make calls using AMQP to the heat-engine:: +<../contributor/architecture>` and shown in the diagram below, where we have +a CLI that sends HTTP requests to the REST and CFN APIs, which in turn make +calls using AMQP to the heat-engine:: |- [REST API] -| [CLI] -- -- -- -- [ENGINE]