Browse Source

Migrate doc path to contributor

Migrate document contributing and developing_guides to
contributor.

Change-Id: I6308992451c8d65fb7c1b99c73b801bbf6152999
changes/78/648478/9
ricolin 3 years ago
parent
commit
c739be7645
  1. 4
      doc/source/_extra/.htaccess
  2. 19
      doc/source/contributing/index.rst
  3. 0
      doc/source/contributor/architecture.rst
  4. 0
      doc/source/contributor/blueprints.rst
  5. 0
      doc/source/contributor/gmr.rst
  6. 26
      doc/source/contributor/index.rst
  7. 0
      doc/source/contributor/pluginguide.rst
  8. 0
      doc/source/contributor/rally_on_gates.rst
  9. 0
      doc/source/contributor/schedulerhints.rst
  10. 0
      doc/source/contributor/supportstatus.rst
  11. 29
      doc/source/developing_guides/index.rst
  12. 14
      doc/source/index.rst
  13. 6
      doc/source/operating_guides/scale_deployment.rst

4
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

19
doc/source/contributing/index.rst

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

0
doc/source/developing_guides/architecture.rst → doc/source/contributor/architecture.rst

0
doc/source/contributing/blueprints.rst → doc/source/contributor/blueprints.rst

0
doc/source/developing_guides/gmr.rst → doc/source/contributor/gmr.rst

26
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

0
doc/source/developing_guides/pluginguide.rst → doc/source/contributor/pluginguide.rst

0
doc/source/developing_guides/rally_on_gates.rst → doc/source/contributor/rally_on_gates.rst

0
doc/source/developing_guides/schedulerhints.rst → doc/source/contributor/schedulerhints.rst

0
doc/source/developing_guides/supportstatus.rst → doc/source/contributor/supportstatus.rst

29
doc/source/developing_guides/index.rst

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

14
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

6
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] -- <HTTP> -- -- <AMQP> -- [ENGINE]

Loading…
Cancel
Save