openstack/devstack
Code Issues Proposed changes

One last format and content cleanup for the index page

Browse Source 
Update the form of the links to other documents in the tree;
the generated HTML links must remain in the original form.
The layout is changed from the previous tables to a more Sphinx-y
TOC-like list.

Also editorial changes to the index page and guide titles

Change-Id: I52df0cc542754c386fb3c99d9efdf2524c11bf48
This commit is contained in:
Dean Troyer 2014-11-06 09:33:02 -06:00
parent e6165e80ba
commit 26dd21be8c
4 changed files with 114 additions and 215 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/guides/single-machine.rst
View File

@ -1,6 +1,6 @@
========== =========================
All-In-One All-In-One Single Machine
========== =========================
Things are about to get real! Using OpenStack in containers or VMs is Things are about to get real! Using OpenStack in containers or VMs is
nice for kicking the tires, but doesn't compare to the feeling you get nice for kicking the tires, but doesn't compare to the feeling you get

6
doc/source/guides/single-vm.rst
View File

@ -1,6 +1,6 @@
============= ====================
Cloud in a VM All-In-One Single VM
============= ====================
Use the cloud to build the cloud! Use your cloud to launch new versions Use the cloud to build the cloud! Use your cloud to launch new versions
of OpenStack in about 5 minutes. When you break it, start over! The VMs of OpenStack in about 5 minutes. When you break it, start over! The VMs

308
doc/source/index.rst
View File

@ -12,11 +12,8 @@ DevStack - an OpenStack Community Production
changes changes
contributing contributing
guides/* Quick Start
-----------
Quick Start This ain't your first rodeo
---------------------------------------
#. Select a Linux Distribution #. Select a Linux Distribution
@ -59,40 +56,36 @@ Guides
Walk through various setups used by stackers Walk through various setups used by stackers
OpenStack on VMs .. toctree::
---------------- :glob:
:maxdepth: 1
These guides tell you how to virtualize your OpenStack cloud in virtual guides/single-vm
machines. This means that you can get started without having to purchase guides/single-machine
any hardware. guides/multinode-lab
Virtual Machine All-In-One Single VM
~~~~~~~~~~~~~~~ --------------------
:doc:`Run OpenStack in a VM <guides/single-vm>`. The VMs launched in your cloud will be slow as Run :doc:`OpenStack in a VM <guides/single-vm>`. The VMs launched in your cloud will be slow as
they are running in QEMU (emulation), but it is useful if you don't have they are running in QEMU (emulation), but it is useful if you don't have
spare hardware laying around. :doc:`[Read] <guides/single-vm>` spare hardware laying around. :doc:`[Read] <guides/single-vm>`
OpenStack on Hardware All-In-One Single Machine
--------------------- -------------------------
These guides tell you how to deploy a development environment on real Run :doc:`OpenStack on dedicated hardware <guides/single-machine>` This can include a
hardware. Guides range from running OpenStack on a single laptop to server-class machine or a laptop at home.
running a multi-node deployment on datacenter hardware. :doc:`[Read] <guides/single-machine>`
All-In-One Multi-Node Lab
~~~~~~~~~~ --------------
:doc:`Run OpenStack on dedicated hardware <guides/single-machine>` to get real performance in your VMs. Setup a :doc:`multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management.
This can include a server-class machine or a laptop at home. :doc:`[Read] <guides/single-machine>` :doc:`[Read] <guides/multinode-lab>`
Multi-Node + VLANs DevStack Documentation
~~~~~~~~~~~~~~~~~~ ======================
:doc:`Setup a multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management. :doc:`[Read] <guides/multinode-lab>`
Documentation
=============
Overview Overview
-------- --------
@ -127,187 +120,102 @@ Contributing
Code Code
==== ====
A look at the bits that make it all go *A look at the bits that make it all go*
Scripts Scripts
------- -------
Generated documentation of DevStack scripts. * `stack.sh <stack.sh.html>`__ - The main script
* `functions <functions.html>`__ - DevStack-specific functions
* `functions-common <functions-common.html>`__ - Functions shared with other projects
* `lib/apache <lib/apache.html>`__
* `lib/baremetal <lib/baremetal.html>`__
* `lib/ceilometer <lib/ceilometer.html>`__
* `lib/ceph <lib/ceph.html>`__
* `lib/cinder <lib/cinder.html>`__
* `lib/config <lib/config.html>`__
* `lib/database <lib/database.html>`__
* `lib/dib <lib/dib.html>`__
* `lib/dstat <lib/dstat.html>`__
* `lib/glance <lib/glance.html>`__
* `lib/heat <lib/heat.html>`__
* `lib/horizon <lib/horizon.html>`__
* `lib/infra <lib/infra.html>`__
* `lib/ironic <lib/ironic.html>`__
* `lib/keystone <lib/keystone.html>`__
* `lib/ldap <lib/ldap.html>`__
* `lib/neutron <lib/neutron.html>`__
* `lib/nova <lib/nova.html>`__
* `lib/opendaylight <lib/opendaylight.html>`__
* `lib/oslo <lib/oslo.html>`__
* `lib/rpc\_backend <lib/rpc_backend.html>`__
* `lib/sahara <lib/sahara.html>`__
* `lib/stackforge <lib/stackforge.html>`__
* `lib/swift <lib/swift.html>`__
* `lib/tempest <lib/tempest.html>`__
* `lib/tls <lib/tls.html>`__
* `lib/trove <lib/trove.html>`__
* `lib/zaqar <lib/zaqar.html>`__
* `unstack.sh <unstack.sh.html>`__
* `clean.sh <clean.sh.html>`__
* `run\_tests.sh <run_tests.sh.html>`__
+-------------------------------+----------------------------------------------+ * `extras.d/40-dib.sh <extras.d/40-dib.sh.html>`__
| Filename | Link | * `extras.d/50-ironic.sh <extras.d/50-ironic.sh.html>`__
+===============================+==============================================+ * `extras.d/60-ceph.sh <extras.d/60-ceph.sh.html>`__
| stack.sh | `Read » <stack.sh.html>`__ | * `extras.d/70-sahara.sh <extras.d/70-sahara.sh.html>`__
+-------------------------------+----------------------------------------------+ * `extras.d/70-trove.sh <extras.d/70-trove.sh.html>`__
| functions | `Read » <functions.html>`__ | * `extras.d/70-zaqar.sh <extras.d/70-zaqar.sh.html>`__
+-------------------------------+----------------------------------------------+ * `extras.d/80-opendaylight.sh <extras.d/80-opendaylight.sh.html>`__
| functions-common | `Read » <functions-common.html>`__ | * `extras.d/80-tempest.sh <extras.d/80-tempest.sh.html>`__
+-------------------------------+----------------------------------------------+
| lib/apache | `Read » <lib/apache.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/baremetal | `Read » <lib/baremetal.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/ceilometer | `Read » <lib/ceilometer.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/cinder | `Read » <lib/cinder.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/config | `Read » <lib/config.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/database | `Read » <lib/database.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/glance | `Read » <lib/glance.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/heat | `Read » <lib/heat.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/horizon | `Read » <lib/horizon.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/infra | `Read » <lib/infra.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/ironic | `Read » <lib/ironic.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/keystone | `Read » <lib/keystone.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/ldap | `Read » <lib/ldap.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/zaqar | `Read » <lib/zaqar.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/neutron | `Read » <lib/neutron.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/nova | `Read » <lib/nova.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/oslo | `Read » <lib/oslo.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/rpc\_backend | `Read » <lib/rpc_backend.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/sahara | `Read » <lib/sahara.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/savanna | `Read » <lib/savanna.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/stackforge | `Read » <lib/stackforge.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/swift | `Read » <lib/swift.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/tempest | `Read » <lib/tempest.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/tls | `Read » <lib/tls.html>`__ |
+-------------------------------+----------------------------------------------+
| lib/trove | `Read » <lib/trove.html>`__ |
+-------------------------------+----------------------------------------------+
| unstack.sh | `Read » <unstack.sh.html>`__ |
+-------------------------------+----------------------------------------------+
| clean.sh | `Read » <clean.sh.html>`__ |
+-------------------------------+----------------------------------------------+
| run\_tests.sh | `Read » <run_tests.sh.html>`__ |
+-------------------------------+----------------------------------------------+
| extras.d/50-ironic.sh | `Read » <extras.d/50-ironic.html>`__ |
+-------------------------------+----------------------------------------------+
| extras.d/70-zaqar.sh | `Read » <extras.d/70-zaqar.html>`__ |
+-------------------------------+----------------------------------------------+
| extras.d/70-sahara.sh | `Read » <extras.d/70-sahara.html>`__ |
+-------------------------------+----------------------------------------------+
| extras.d/70-savanna.sh | `Read » <extras.d/70-savanna.html>`__ |
+-------------------------------+----------------------------------------------+
| extras.d/70-trove.sh | `Read » <extras.d/70-trove.html>`__ |
+-------------------------------+----------------------------------------------+
| extras.d/80-opendaylight.sh | `Read » <extras.d/80-opendaylight.html>`__ |
+-------------------------------+----------------------------------------------+
| extras.d/80-tempest.sh | `Read » <extras.d/80-tempest.html>`__ |
+-------------------------------+----------------------------------------------+
Configuration Configuration
------------- -------------
+--------------+--------------------------------+
| Filename | Link |
+==============+================================+
| local.conf | `Read » <local.conf.html>`__ |
+--------------+--------------------------------+
| stackrc | `Read » <stackrc.html>`__ |
+--------------+--------------------------------+
| openrc | `Read » <openrc.html>`__ |
+--------------+--------------------------------+
| exerciserc | `Read » <exerciserc.html>`__ |
+--------------+--------------------------------+
| eucarc | `Read » <eucarc.html>`__ |
+--------------+--------------------------------+
Tools
-----
+-----------------------------+----------------------------------------------+
| Filename | Link |
+=============================+==============================================+
| tools/info.sh | `Read » <tools/info.sh.html>`__ |
+-----------------------------+----------------------------------------------+
| tools/build\_docs.sh | `Read » <tools/build_docs.sh.html>`__ |
+-----------------------------+----------------------------------------------+
| tools/create\_userrc.sh | `Read » <tools/create_userrc.sh.html>`__ |
+-----------------------------+----------------------------------------------+
| tools/fixup\_stuff.sh | `Read » <tools/fixup_stuff.sh.html>`__ |
+-----------------------------+----------------------------------------------+
| tools/install\_prereqs.sh | `Read » <tools/install_prereqs.sh.html>`__ |
+-----------------------------+----------------------------------------------+
| tools/install\_pip.sh | `Read » <tools/install_pip.sh.html>`__ |
+-----------------------------+----------------------------------------------+
| tools/upload\_image.sh | `Read » <tools/upload_image.sh.html>`__ |
+-----------------------------+----------------------------------------------+
Samples
-------
Generated documentation of DevStack sample files.
+------------+--------------------------------------+
| Filename | Link |
+============+======================================+
| local.sh | `Read » <samples/local.sh.html>`__ |
+------------+--------------------------------------+
| localrc | `Read » <samples/localrc.html>`__ |
+------------+--------------------------------------+
Exercises
---------
+---------------------------------+-------------------------------------------------+
| Filename | Link |
+=================================+=================================================+
| exercise.sh | `Read » <exercise.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/aggregates.sh | `Read » <exercises/aggregates.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/boot\_from\_volume.sh | `Read » <exercises/boot_from_volume.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/bundle.sh | `Read » <exercises/bundle.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/client-args.sh | `Read » <exercises/client-args.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/client-env.sh | `Read » <exercises/client-env.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/euca.sh | `Read » <exercises/euca.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/floating\_ips.sh | `Read » <exercises/floating_ips.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/horizon.sh | `Read » <exercises/horizon.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/neutron-adv-test.sh | `Read » <exercises/neutron-adv-test.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/sahara.sh | `Read » <exercises/sahara.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/savanna.sh | `Read » <exercises/savanna.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/sec\_groups.sh | `Read » <exercises/sec_groups.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/swift.sh | `Read » <exercises/swift.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/trove.sh | `Read » <exercises/trove.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/volumes.sh | `Read » <exercises/volumes.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
| exercises/zaqar.sh | `Read » <exercises/zaqar.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
.. toctree:: .. toctree::
:glob: :glob:
:maxdepth: 1 :maxdepth: 1
* local.conf
stackrc
openrc
exerciserc
eucarc
Tools
-----
* `tools/build\_docs.sh <tools/build_docs.sh.html>`__
* `tools/create-stack-user.sh <tools/create-stack-user.sh.html>`__
* `tools/create\_userrc.sh <tools/create_userrc.sh.html>`__
* `tools/fixup\_stuff.sh <tools/fixup_stuff.sh.html>`__
* `tools/info.sh <tools/info.sh.html>`__
* `tools/install\_pip.sh <tools/install_pip.sh.html>`__
* `tools/install\_prereqs.sh <tools/install_prereqs.sh.html>`__
* `tools/make\_cert.sh <tools/make_cert.sh.html>`__
* `tools/upload\_image.sh <tools/upload_image.sh.html>`__
Samples
-------
* `local.sh <samples/local.sh.html>`__
Exercises
---------
* `exercise.sh <exercise.sh.html>`__
* `exercises/aggregates.sh <exercises/aggregates.sh.html>`__
* `exercises/boot\_from\_volume.sh <exercises/boot_from_volume.sh.html>`__
* `exercises/bundle.sh <exercises/bundle.sh.html>`__
* `exercises/client-args.sh <exercises/client-args.sh.html>`__
* `exercises/client-env.sh <exercises/client-env.sh.html>`__
* `exercises/euca.sh <exercises/euca.sh.html>`__
* `exercises/floating\_ips.sh <exercises/floating_ips.sh.html>`__
* `exercises/horizon.sh <exercises/horizon.sh.html>`__
* `exercises/neutron-adv-test.sh <exercises/neutron-adv-test.sh.html>`__
* `exercises/sahara.sh <exercises/sahara.sh.html>`__
* `exercises/sec\_groups.sh <exercises/sec_groups.sh.html>`__
* `exercises/swift.sh <exercises/swift.sh.html>`__
* `exercises/trove.sh <exercises/trove.sh.html>`__
* `exercises/volumes.sh <exercises/volumes.sh.html>`__
* `exercises/zaqar.sh <exercises/zaqar.sh.html>`__

9
doc/source/localrc.rst
View File

@ -1,9 +0,0 @@
=====================
localrc - The Old Way
=====================
``localrc`` is the old file used to configure DevStack. It is deprecated
and has been replaced by ```local.conf`` <local.conf.html>`__. DevStack
will continue to use ``localrc`` if it is present and ignore the
``localrc`` section in ``local.conf.``. Remove ``localrc`` to switch to
using the new file.