Merge "docs: Move development section under contributor guide"

This commit is contained in:
Zuul 2020-09-24 08:00:41 +00:00 committed by Gerrit Code Review
commit 0a08cc77cf
14 changed files with 31 additions and 44 deletions

View File

@ -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/nova-cells.html$ /$1/configuration/reference/nova-cells.html
redirectmatch 301 ^/([^/]+/[^/]+)/configuration/physical-network.html$ /$1/configuration/reference/physical-network.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 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

View File

@ -1,4 +1,4 @@
.. _development-automated: .. _contributor-automated:
=============== ===============
Automated Setup Automated Setup
@ -7,7 +7,7 @@ Automated Setup
This section provides information on the development tools provided by kayobe This section provides information on the development tools provided by kayobe
to automate the deployment of various development environments. 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 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 Inspect the kayobe configuration and make any changes necessary for your
environment. 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. your environment for use with Vagrant and bring up a Vagrant VM.
If not using Vagrant, the default development configuration expects the 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 ./dev/overcloud-upgrade.sh
.. _development-automated-seed: .. _contributor-automated-seed:
Seed Seed
==== ====
These instructions cover deploying the seed services directly rather than in a 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. deployment of the seed services in a VM.
Preparation Preparation
@ -255,7 +255,7 @@ The machines and networking created by Tenks can be cleaned up via
./dev/tenks-teardown-overcloud.sh ./tenks ./dev/tenks-teardown-overcloud.sh ./tenks
.. _development-automated-seed-hypervisor: .. _contributor-automated-seed-hypervisor:
Seed Hypervisor Seed Hypervisor
=============== ===============
@ -308,13 +308,13 @@ hypervisor::
Upon successful completion of this script, the seed hypervisor will be active. Upon successful completion of this script, the seed hypervisor will be active.
.. _development-automated-seed-vm: .. _contributor-automated-seed-vm:
Seed VM Seed VM
======= =======
The seed VM should be deployed on a system configured as a libvirt/KVM 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 Preparation
----------- -----------

View File

@ -105,4 +105,4 @@ Project Team Lead Duties
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
All common PTL duties are enumerated in the `PTL guide <https://docs.openstack.org/project-team-guide/ptl.html>`_. All common PTL duties are enumerated in the `PTL guide <https://docs.openstack.org/project-team-guide/ptl.html>`_.
Release tasks are described in the :doc:`Kayobe releases guide <../development/releases>`. Release tasks are described in the :doc:`Kayobe releases guide <releases>`.

View File

@ -13,4 +13,10 @@ We welcome everyone to join our project!
:maxdepth: 1 :maxdepth: 1
contributing contributing
development
vagrant
manual
automated
testing
release-notes release-notes
releases

View File

@ -1,4 +1,4 @@
.. _development-manual: .. _contributor-manual:
============ ============
Manual Setup 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 for an OpenStack controller in a virtual machine using `Vagrant
<https://www.vagrantup.com/>`_ and Kayobe. <https://www.vagrantup.com/>`_ 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 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. use with Vagrant and bring up a Vagrant VM.
Manual Installation Manual Installation

View File

@ -1,4 +1,4 @@
.. _development-vagrant: .. _contributor-vagrant:
======= =======
Vagrant Vagrant

View File

@ -1,5 +0,0 @@
=================
How to Contribute
=================
The contributor guide has moved to :doc:`../contributor/contributing`.

View File

@ -1,14 +0,0 @@
========================
Kayobe Development Guide
========================
.. toctree::
:maxdepth: 2
vagrant
manual
automated
development
testing
releases
contributing

View File

@ -5,7 +5,7 @@ We advise new users start by reading the :doc:`Architecture <architecture>`
documentation first in order to understand Kayobe's various components. documentation first in order to understand Kayobe's various components.
For users wishing to learn interactively we recommend starting at either For users wishing to learn interactively we recommend starting at either
the :doc:`all-in-one overcloud <development/automated>` deployment or the :doc:`all-in-one overcloud <contributor/automated>` deployment or
the :ref:`'A Universe From Nothing' <a-universe-from-nothing>` the :ref:`'A Universe From Nothing' <a-universe-from-nothing>`
deployment guide. deployment guide.
@ -26,5 +26,5 @@ and then :doc:`Deployment <deployment>` to deploy to it.
* :doc:`Administration <administration/index>` - Post-deploy administration * :doc:`Administration <administration/index>` - Post-deploy administration
tasks tasks
* :doc:`Resources <resources>` - External links to Kayobe resources * :doc:`Resources <resources>` - External links to Kayobe resources
* :doc:`Development <development/index>` - Deploying Kayobe development * :doc:`Contributor <contributor/index>` - Contributing to Kayobe and deploying
environments Kayobe development environments

View File

@ -15,7 +15,7 @@ understanding and using Kayobe.
This documentation is maintained at opendev.org This documentation is maintained at opendev.org
`here <https://opendev.org/openstack/kayobe.git>`_. Feedback and contributions `here <https://opendev.org/openstack/kayobe.git>`_. Feedback and contributions
welcome, see :doc:`contributing <development/contributing>` for information on welcome, see :doc:`contributing <contributor/contributing>` for information on
how. how.
.. include:: ../../README.rst .. include:: ../../README.rst
@ -53,11 +53,3 @@ Contributor Guide
:maxdepth: 2 :maxdepth: 2
contributor/index contributor/index
Developer Documentation
-----------------------
.. toctree::
:maxdepth: 2
development/index

View File

@ -23,3 +23,7 @@
/kayobe/latest/configuration/nova-cells.html 301 /kayobe/latest/configuration/reference/nova-cells.html /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/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 /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