Migrate doc path to contributor

Migrate document contributing and developing_guides to
contributor.

Change-Id: I6308992451c8d65fb7c1b99c73b801bbf6152999
This commit is contained in:
ricolin 2019-03-20 20:08:25 +08:00
parent 88528fb7de
commit c739be7645
13 changed files with 39 additions and 59 deletions

View File

@ -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/([^/]+)/(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/([^/]+)/configuration/(api|clients)\.html /heat/$1/configuration/config-options.html
redirectmatch 301 ^/heat/([^/]+)/contributing/(index|blueprints)\.html /heat/$1/contributor/$2.html

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -90,14 +90,14 @@ Developing Heat
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
contributing/index contributor/index
getting_started/on_devstack getting_started/on_devstack
developing_guides/architecture contributor/architecture
developing_guides/pluginguide contributor/pluginguide
developing_guides/schedulerhints contributor/schedulerhints
developing_guides/gmr contributor/gmr
developing_guides/supportstatus contributor/supportstatus
developing_guides/rally_on_gates contributor/rally_on_gates
api/index api/index
Indices and tables Indices and tables

View File

@ -48,9 +48,9 @@ Basic Architecture
------------------ ------------------
The heat architecture is as defined at :doc:`heat architecture The heat architecture is as defined at :doc:`heat architecture
<../developing_guides/architecture>` and shown in the diagram below, <../contributor/architecture>` and shown in the diagram below, where we have
where we have a CLI that sends HTTP requests to the REST and CFN APIs, which in a CLI that sends HTTP requests to the REST and CFN APIs, which in turn make
turn make calls using AMQP to the heat-engine:: calls using AMQP to the heat-engine::
|- [REST API] -| |- [REST API] -|
[CLI] -- <HTTP> -- -- <AMQP> -- [ENGINE] [CLI] -- <HTTP> -- -- <AMQP> -- [ENGINE]