diff options
| -rw-r--r-- | doc/source/conf.py (renamed from doc/conf.py) | 0 | ||||
| -rw-r--r-- | doc/source/contributor/CONTRIBUTING.rst (renamed from doc/CONTRIBUTING.rst) | 0 | ||||
| -rw-r--r-- | doc/source/contributor/bug-triage.rst (renamed from doc/bug-triage.rst) | 0 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 10 | ||||
| -rw-r--r-- | doc/source/contributor/running-tests.rst (renamed from doc/running-tests.rst) | 0 | ||||
| -rw-r--r-- | doc/source/contributor/vagrant-dev-env.rst (renamed from doc/vagrant-dev-env.rst) | 0 | ||||
| -rw-r--r-- | doc/source/index.rst (renamed from doc/index.rst) | 57 | ||||
| -rw-r--r-- | doc/source/reference/bifrost.rst (renamed from doc/bifrost.rst) | 14 | ||||
| -rw-r--r-- | doc/source/reference/central-logging-guide.rst (renamed from doc/central-logging-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/ceph-guide.rst (renamed from doc/ceph-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/cinder-guide-hnas.rst (renamed from doc/cinder-guide-hnas.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/cinder-guide.rst (renamed from doc/cinder-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/designate-guide.rst (renamed from doc/designate-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/external-ceph-guide.rst (renamed from doc/external-ceph-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/hyperv-guide.rst (renamed from doc/hyperv-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 26 | ||||
| -rw-r--r-- | doc/source/reference/ironic-guide.rst (renamed from doc/ironic-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/kollanet.png (renamed from doc/kollanet.png) | bin | 26014 -> 26014 bytes | |||
| -rw-r--r-- | doc/source/reference/kuryr-guide.rst (renamed from doc/kuryr-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/manila-guide.rst (renamed from doc/manila-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/manila-hnas-guide.rst (renamed from doc/manila-hnas-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/networking-guide.rst (renamed from doc/networking-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/nova-fake-driver.rst (renamed from doc/nova-fake-driver.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/osprofiler-guide.rst (renamed from doc/osprofiler-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/skydive-guide.rst (renamed from doc/skydive-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/swift-guide.rst (renamed from doc/swift-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/tacker-guide.rst (renamed from doc/tacker-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/vmware-guide.rst (renamed from doc/vmware-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/zun-guide.rst (renamed from doc/zun-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/advanced-configuration.rst (renamed from doc/advanced-configuration.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/deployment-philosophy.rst (renamed from doc/deployment-philosophy.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 16 | ||||
| -rw-r--r-- | doc/source/user/kolla-for-openstack-development.rst (renamed from doc/kolla-for-openstack-development.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/multi-regions.rst (renamed from doc/multi-regions.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/multinode.rst (renamed from doc/multinode.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/operating-kolla.rst (renamed from doc/operating-kolla.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/production-architecture-guide.rst (renamed from doc/production-architecture-guide.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/quickstart.rst (renamed from doc/quickstart.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/security.rst (renamed from doc/security.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/troubleshooting.rst (renamed from doc/troubleshooting.rst) | 0 | ||||
| -rw-r--r-- | setup.cfg | 2 |
41 files changed, 73 insertions, 52 deletions
diff --git a/doc/conf.py b/doc/source/conf.py index 7219f5feb..7219f5feb 100644 --- a/doc/conf.py +++ b/doc/source/conf.py diff --git a/doc/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst index 7092cd88b..7092cd88b 100644 --- a/doc/CONTRIBUTING.rst +++ b/doc/source/contributor/CONTRIBUTING.rst diff --git a/doc/bug-triage.rst b/doc/source/contributor/bug-triage.rst index d5d24ca15..d5d24ca15 100644 --- a/doc/bug-triage.rst +++ b/doc/source/contributor/bug-triage.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..c2d7d4d97 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,10 @@ +Developer Docs +============== + +.. toctree:: + :maxdepth: 1 + + CONTRIBUTING + vagrant-dev-env + running-tests + bug-triage diff --git a/doc/running-tests.rst b/doc/source/contributor/running-tests.rst index 317f2d948..317f2d948 100644 --- a/doc/running-tests.rst +++ b/doc/source/contributor/running-tests.rst diff --git a/doc/vagrant-dev-env.rst b/doc/source/contributor/vagrant-dev-env.rst index 9c9a0c075..9c9a0c075 100644 --- a/doc/vagrant-dev-env.rst +++ b/doc/source/contributor/vagrant-dev-env.rst diff --git a/doc/index.rst b/doc/source/index.rst index ea02ce5f1..c7c33fa52 100644 --- a/doc/index.rst +++ b/doc/source/index.rst @@ -34,57 +34,26 @@ refer to the `Kolla image documentation <https://docs.openstack.org/kolla/latest/>`_. -Overview -======== +User Guides +=========== .. toctree:: - :maxdepth: 1 - - deployment-philosophy - production-architecture-guide - quickstart - multinode - multi-regions - advanced-configuration - operating-kolla - security - kolla-for-openstack-development - troubleshooting - -Services -======== + :maxdepth: 2 + + user/index + +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 + :maxdepth: 2 + + reference/index Developer Docs ============== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - CONTRIBUTING - vagrant-dev-env - running-tests - bug-triage + contributor/index diff --git a/doc/bifrost.rst b/doc/source/reference/bifrost.rst index 38c755ae3..592ed093b 100644 --- a/doc/bifrost.rst +++ b/doc/source/reference/bifrost.rst @@ -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``: diff --git a/doc/central-logging-guide.rst b/doc/source/reference/central-logging-guide.rst index 938b8b137..938b8b137 100644 --- a/doc/central-logging-guide.rst +++ b/doc/source/reference/central-logging-guide.rst diff --git a/doc/ceph-guide.rst b/doc/source/reference/ceph-guide.rst index 61e2f7b1c..61e2f7b1c 100644 --- a/doc/ceph-guide.rst +++ b/doc/source/reference/ceph-guide.rst diff --git a/doc/cinder-guide-hnas.rst b/doc/source/reference/cinder-guide-hnas.rst index c064e3c05..c064e3c05 100644 --- a/doc/cinder-guide-hnas.rst +++ b/doc/source/reference/cinder-guide-hnas.rst diff --git a/doc/cinder-guide.rst b/doc/source/reference/cinder-guide.rst index 937e99ac8..937e99ac8 100644 --- a/doc/cinder-guide.rst +++ b/doc/source/reference/cinder-guide.rst diff --git a/doc/designate-guide.rst b/doc/source/reference/designate-guide.rst index 3c4b39047..3c4b39047 100644 --- a/doc/designate-guide.rst +++ b/doc/source/reference/designate-guide.rst diff --git a/doc/external-ceph-guide.rst b/doc/source/reference/external-ceph-guide.rst index ef5875e71..ef5875e71 100644 --- a/doc/external-ceph-guide.rst +++ b/doc/source/reference/external-ceph-guide.rst diff --git a/doc/hyperv-guide.rst b/doc/source/reference/hyperv-guide.rst index 3b175267b..3b175267b 100644 --- a/doc/hyperv-guide.rst +++ b/doc/source/reference/hyperv-guide.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 000000000..aa819df04 --- /dev/null +++ b/doc/source/reference/index.rst @@ -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 diff --git a/doc/ironic-guide.rst b/doc/source/reference/ironic-guide.rst index 0d324b2ef..0d324b2ef 100644 --- a/doc/ironic-guide.rst +++ b/doc/source/reference/ironic-guide.rst diff --git a/doc/kollanet.png b/doc/source/reference/kollanet.png Binary files differindex cfb0c6014..cfb0c6014 100644 --- a/doc/kollanet.png +++ b/doc/source/reference/kollanet.png diff --git a/doc/kuryr-guide.rst b/doc/source/reference/kuryr-guide.rst index eb47ef87a..eb47ef87a 100644 --- a/doc/kuryr-guide.rst +++ b/doc/source/reference/kuryr-guide.rst diff --git a/doc/manila-guide.rst b/doc/source/reference/manila-guide.rst index d72a3b30c..d72a3b30c 100644 --- a/doc/manila-guide.rst +++ b/doc/source/reference/manila-guide.rst diff --git a/doc/manila-hnas-guide.rst b/doc/source/reference/manila-hnas-guide.rst index 258c7e5b8..258c7e5b8 100644 --- a/doc/manila-hnas-guide.rst +++ b/doc/source/reference/manila-hnas-guide.rst diff --git a/doc/networking-guide.rst b/doc/source/reference/networking-guide.rst index 04f29f3d4..04f29f3d4 100644 --- a/doc/networking-guide.rst +++ b/doc/source/reference/networking-guide.rst diff --git a/doc/nova-fake-driver.rst b/doc/source/reference/nova-fake-driver.rst index dd1557710..dd1557710 100644 --- a/doc/nova-fake-driver.rst +++ b/doc/source/reference/nova-fake-driver.rst diff --git a/doc/osprofiler-guide.rst b/doc/source/reference/osprofiler-guide.rst index b94b65571..b94b65571 100644 --- a/doc/osprofiler-guide.rst +++ b/doc/source/reference/osprofiler-guide.rst diff --git a/doc/skydive-guide.rst b/doc/source/reference/skydive-guide.rst index 4e4f201f7..4e4f201f7 100644 --- a/doc/skydive-guide.rst +++ b/doc/source/reference/skydive-guide.rst diff --git a/doc/swift-guide.rst b/doc/source/reference/swift-guide.rst index f4339cc72..f4339cc72 100644 --- a/doc/swift-guide.rst +++ b/doc/source/reference/swift-guide.rst diff --git a/doc/tacker-guide.rst b/doc/source/reference/tacker-guide.rst index 72b341d4a..72b341d4a 100644 --- a/doc/tacker-guide.rst +++ b/doc/source/reference/tacker-guide.rst diff --git a/doc/vmware-guide.rst b/doc/source/reference/vmware-guide.rst index 1b4ab108b..1b4ab108b 100644 --- a/doc/vmware-guide.rst +++ b/doc/source/reference/vmware-guide.rst diff --git a/doc/zun-guide.rst b/doc/source/reference/zun-guide.rst index 647d95933..647d95933 100644 --- a/doc/zun-guide.rst +++ b/doc/source/reference/zun-guide.rst diff --git a/doc/advanced-configuration.rst b/doc/source/user/advanced-configuration.rst index 0b97bff6b..0b97bff6b 100644 --- a/doc/advanced-configuration.rst +++ b/doc/source/user/advanced-configuration.rst diff --git a/doc/deployment-philosophy.rst b/doc/source/user/deployment-philosophy.rst index 959148e4c..959148e4c 100644 --- a/doc/deployment-philosophy.rst +++ b/doc/source/user/deployment-philosophy.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 000000000..786a54610 --- /dev/null +++ b/doc/source/user/index.rst @@ -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 diff --git a/doc/kolla-for-openstack-development.rst b/doc/source/user/kolla-for-openstack-development.rst index af2d1f9f1..af2d1f9f1 100644 --- a/doc/kolla-for-openstack-development.rst +++ b/doc/source/user/kolla-for-openstack-development.rst diff --git a/doc/multi-regions.rst b/doc/source/user/multi-regions.rst index 045f657f6..045f657f6 100644 --- a/doc/multi-regions.rst +++ b/doc/source/user/multi-regions.rst diff --git a/doc/multinode.rst b/doc/source/user/multinode.rst index 75c671fd7..75c671fd7 100644 --- a/doc/multinode.rst +++ b/doc/source/user/multinode.rst diff --git a/doc/operating-kolla.rst b/doc/source/user/operating-kolla.rst index 6d08b4206..6d08b4206 100644 --- a/doc/operating-kolla.rst +++ b/doc/source/user/operating-kolla.rst diff --git a/doc/production-architecture-guide.rst b/doc/source/user/production-architecture-guide.rst index afeef30c7..afeef30c7 100644 --- a/doc/production-architecture-guide.rst +++ b/doc/source/user/production-architecture-guide.rst diff --git a/doc/quickstart.rst b/doc/source/user/quickstart.rst index ab52bc58b..ab52bc58b 100644 --- a/doc/quickstart.rst +++ b/doc/source/user/quickstart.rst diff --git a/doc/security.rst b/doc/source/user/security.rst index f14dabaeb..f14dabaeb 100644 --- a/doc/security.rst +++ b/doc/source/user/security.rst diff --git a/doc/troubleshooting.rst b/doc/source/user/troubleshooting.rst index b7a120d3d..b7a120d3d 100644 --- a/doc/troubleshooting.rst +++ b/doc/source/user/troubleshooting.rst @@ -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] |
