diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess index df4bd364c..b78a9292c 100644 --- a/doc/source/_extra/.htaccess +++ b/doc/source/_extra/.htaccess @@ -12,3 +12,7 @@ redirectmatch 301 ^/([^/]+/[^/]+)/configuration/network.html$ /$1/configuration/ redirectmatch 301 ^/([^/]+/[^/]+)/configuration/nova-cells.html$ /$1/configuration/reference/nova-cells.html redirectmatch 301 ^/([^/]+/[^/]+)/configuration/physical-network.html$ /$1/configuration/reference/physical-network.html redirectmatch 301 ^/([^/]+/[^/]+)/configuration/seed-custom-containers.html$ /$1/configuration/reference/seed-custom-containers.html + +# The following redirects were added when development/* was moved to +# contributor/*. +redirectmatch 301 ^/([^/]+/[^/]+)/development/([^/]+).html$ /$1/contributor/$2.html diff --git a/doc/source/development/automated.rst b/doc/source/contributor/automated.rst similarity index 96% rename from doc/source/development/automated.rst rename to doc/source/contributor/automated.rst index 6c064b249..ee1c81c5a 100644 --- a/doc/source/development/automated.rst +++ b/doc/source/contributor/automated.rst @@ -1,4 +1,4 @@ -.. _development-automated: +.. _contributor-automated: =============== Automated Setup @@ -7,7 +7,7 @@ Automated Setup This section provides information on the development tools provided by kayobe to automate the deployment of various development environments. -For a manual procedure, see :ref:`development-manual`. +For a manual procedure, see :ref:`contributor-manual`. Overview ======== @@ -56,7 +56,7 @@ Clone the ``kayobe-config-dev`` repository to ``config/src/kayobe-config``:: Inspect the kayobe configuration and make any changes necessary for your environment. -If using Vagrant, follow the steps in :ref:`development-vagrant` to prepare +If using Vagrant, follow the steps in :ref:`contributor-vagrant` to prepare your environment for use with Vagrant and bring up a Vagrant VM. If not using Vagrant, the default development configuration expects the @@ -168,13 +168,13 @@ It is possible to test an upgrade from a previous release by running the ./dev/overcloud-upgrade.sh -.. _development-automated-seed: +.. _contributor-automated-seed: Seed ==== These instructions cover deploying the seed services directly rather than in a -VM. See :ref:`development-automated-seed-vm` for instructions covering +VM. See :ref:`contributor-automated-seed-vm` for instructions covering deployment of the seed services in a VM. Preparation @@ -255,7 +255,7 @@ The machines and networking created by Tenks can be cleaned up via ./dev/tenks-teardown-overcloud.sh ./tenks -.. _development-automated-seed-hypervisor: +.. _contributor-automated-seed-hypervisor: Seed Hypervisor =============== @@ -308,13 +308,13 @@ hypervisor:: Upon successful completion of this script, the seed hypervisor will be active. -.. _development-automated-seed-vm: +.. _contributor-automated-seed-vm: Seed VM ======= The seed VM should be deployed on a system configured as a libvirt/KVM -hypervisor, using :ref:`development-automated-seed-hypervisor` or otherwise. +hypervisor, using :ref:`contributor-automated-seed-hypervisor` or otherwise. Preparation ----------- diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index ce07c6b53..303649d3e 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -105,4 +105,4 @@ Project Team Lead Duties ~~~~~~~~~~~~~~~~~~~~~~~~ All common PTL duties are enumerated in the `PTL guide `_. -Release tasks are described in the :doc:`Kayobe releases guide <../development/releases>`. +Release tasks are described in the :doc:`Kayobe releases guide `. diff --git a/doc/source/development/development.rst b/doc/source/contributor/development.rst similarity index 100% rename from doc/source/development/development.rst rename to doc/source/contributor/development.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index adfce7743..e82d2102b 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -13,4 +13,10 @@ We welcome everyone to join our project! :maxdepth: 1 contributing + development + vagrant + manual + automated + testing release-notes + releases diff --git a/doc/source/development/manual.rst b/doc/source/contributor/manual.rst similarity index 91% rename from doc/source/development/manual.rst rename to doc/source/contributor/manual.rst index b007826d6..e196e6af6 100644 --- a/doc/source/development/manual.rst +++ b/doc/source/contributor/manual.rst @@ -1,4 +1,4 @@ -.. _development-manual: +.. _contributor-manual: ============ Manual Setup @@ -8,12 +8,12 @@ This section provides a set of manual steps to set up a development environment for an OpenStack controller in a virtual machine using `Vagrant `_ and Kayobe. -For a more automated and flexible procedure, see :ref:`development-automated`. +For a more automated and flexible procedure, see :ref:`contributor-automated`. Preparation =========== -Follow the steps in :ref:`development-vagrant` to prepare your environment for +Follow the steps in :ref:`contributor-vagrant` to prepare your environment for use with Vagrant and bring up a Vagrant VM. Manual Installation diff --git a/doc/source/development/releases.rst b/doc/source/contributor/releases.rst similarity index 100% rename from doc/source/development/releases.rst rename to doc/source/contributor/releases.rst diff --git a/doc/source/development/testing.rst b/doc/source/contributor/testing.rst similarity index 100% rename from doc/source/development/testing.rst rename to doc/source/contributor/testing.rst diff --git a/doc/source/development/vagrant.rst b/doc/source/contributor/vagrant.rst similarity index 98% rename from doc/source/development/vagrant.rst rename to doc/source/contributor/vagrant.rst index d54947da3..1613f8f1c 100644 --- a/doc/source/development/vagrant.rst +++ b/doc/source/contributor/vagrant.rst @@ -1,4 +1,4 @@ -.. _development-vagrant: +.. _contributor-vagrant: ======= Vagrant diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst deleted file mode 100644 index 3ab604076..000000000 --- a/doc/source/development/contributing.rst +++ /dev/null @@ -1,5 +0,0 @@ -================= -How to Contribute -================= - -The contributor guide has moved to :doc:`../contributor/contributing`. diff --git a/doc/source/development/index.rst b/doc/source/development/index.rst deleted file mode 100644 index 28756ddb5..000000000 --- a/doc/source/development/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -======================== -Kayobe Development Guide -======================== - -.. toctree:: - :maxdepth: 2 - - vagrant - manual - automated - development - testing - releases - contributing diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index 5f2fdad83..5d4fcf3f3 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -5,7 +5,7 @@ We advise new users start by reading the :doc:`Architecture ` documentation first in order to understand Kayobe's various components. For users wishing to learn interactively we recommend starting at either -the :doc:`all-in-one overcloud ` deployment or +the :doc:`all-in-one overcloud ` deployment or the :ref:`'A Universe From Nothing' ` deployment guide. @@ -26,5 +26,5 @@ and then :doc:`Deployment ` to deploy to it. * :doc:`Administration ` - Post-deploy administration tasks * :doc:`Resources ` - External links to Kayobe resources -* :doc:`Development ` - Deploying Kayobe development - environments +* :doc:`Contributor ` - Contributing to Kayobe and deploying + Kayobe development environments diff --git a/doc/source/index.rst b/doc/source/index.rst index 9c4f0e200..ef2007595 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,7 +15,7 @@ understanding and using Kayobe. This documentation is maintained at opendev.org `here `_. Feedback and contributions -welcome, see :doc:`contributing ` for information on +welcome, see :doc:`contributing ` for information on how. .. include:: ../../README.rst @@ -53,11 +53,3 @@ Contributor Guide :maxdepth: 2 contributor/index - -Developer Documentation ------------------------ - -.. toctree:: - :maxdepth: 2 - - development/index diff --git a/doc/test/redirect-tests.txt b/doc/test/redirect-tests.txt index 400068f4f..0387e3358 100644 --- a/doc/test/redirect-tests.txt +++ b/doc/test/redirect-tests.txt @@ -23,3 +23,7 @@ /kayobe/latest/configuration/nova-cells.html 301 /kayobe/latest/configuration/reference/nova-cells.html /kayobe/latest/configuration/physical-network.html 301 /kayobe/latest/configuration/reference/physical-network.html /kayobe/latest/configuration/seed-custom-containers.html 301 /kayobe/latest/configuration/reference/seed-custom-containers.html + +# Moved /kayobe/latest/development/*.html to /kayobe/latest/contributor/ +/kayobe/latest/development/automated.html 301 /kayobe/latest/contributor/automated.html +/kayobe/latest/development/index.html 301 /kayobe/latest/contributor/index.html