Rearrange existing documentation to fit the new standard layout

For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Co-Authored-By: Eduardo Gonzalez <dabarren@gmail.com>
Change-Id: I3a7c0ed204ee1e9060b5325f20622afe9a5e3040
This commit is contained in:
chenxing 2017-07-24 23:28:39 +08:00 committed by Eduardo Gonzalez
parent 87a4001f9b
commit cbd67ebdb1
41 changed files with 70 additions and 49 deletions

View File

@ -0,0 +1,10 @@
Developer Docs
==============
.. toctree::
:maxdepth: 1
CONTRIBUTING
vagrant-dev-env
running-tests
bug-triage

View File

@ -34,57 +34,26 @@ refer to the `Kolla image documentation
<https://docs.openstack.org/kolla/latest/>`_.
Overview
========
User Guides
===========
.. toctree::
:maxdepth: 1
:maxdepth: 2
deployment-philosophy
production-architecture-guide
quickstart
multinode
multi-regions
advanced-configuration
operating-kolla
security
kolla-for-openstack-development
troubleshooting
user/index
Services
========
Reference
=========
.. toctree::
:maxdepth: 1
:maxdepth: 2
ceph-guide
central-logging-guide
external-ceph-guide
cinder-guide
cinder-guide-hnas
designate-guide
hyperv-guide
ironic-guide
manila-guide
manila-hnas-guide
nova-fake-driver
swift-guide
bifrost
networking-guide
kuryr-guide
zun-guide
osprofiler-guide
skydive-guide
vmware-guide
tacker-guide
reference/index
Developer Docs
==============
.. toctree::
:maxdepth: 1
:maxdepth: 2
CONTRIBUTING
vagrant-dev-env
running-tests
bug-triage
contributor/index

View File

@ -64,11 +64,11 @@ Preparation
Prepare the Control Host
------------------------
Follow the **Install dependencies** section of the :doc:`quickstart` guide
instructions to set up kolla and kolla-ansible dependencies. Follow the
instructions in either the **Install kolla for development** section or the
**Install kolla for deployment or evaluation** section to install kolla and
kolla-ansible.
Follow the **Install dependencies** section of the :doc:`../user/quickstart`
guide instructions to set up kolla and kolla-ansible dependencies. Follow
the instructions in either the **Install kolla for development** section or
the **Install kolla for deployment or evaluation** section to install kolla
and kolla-ansible.
Prepare the Deployment Host
---------------------------
@ -179,8 +179,8 @@ host on which bifrost is deployed.
Prepare Kolla-Ansible Configuration
-----------------------------------
Follow the instructions in :doc:`quickstart` to prepare kolla-ansible's global
configuration file ``globals.yml``. For bifrost, the
Follow the instructions in :doc:`../user/quickstart` to prepare kolla-ansible's
global configuration file ``globals.yml``. For bifrost, the
``bifrost_network_interface`` variable should be set to the name of the
interface that will be used to provision bare metal cloud hosts if this is
different than ``network_interface``. For example to use ``eth1``:

View File

@ -0,0 +1,26 @@
Reference
=========
.. toctree::
:maxdepth: 1
ceph-guide
central-logging-guide
external-ceph-guide
cinder-guide
cinder-guide-hnas
designate-guide
hyperv-guide
ironic-guide
manila-guide
manila-hnas-guide
nova-fake-driver
swift-guide
bifrost
networking-guide
kuryr-guide
zun-guide
osprofiler-guide
skydive-guide
vmware-guide
tacker-guide

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

16
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,16 @@
User Guides
===========
.. toctree::
:maxdepth: 1
deployment-philosophy
production-architecture-guide
quickstart
multinode
multi-regions
advanced-configuration
operating-kolla
security
kolla-for-openstack-development
troubleshooting

View File

@ -53,7 +53,7 @@ setup-hooks =
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc
source-dir = doc/source
warning-is-error = 1
[build_releasenotes]