diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 00000000000..5a66a19b560 --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,11 @@ +================================ +Command-Line Interface Reference +================================ + +.. toctree:: + :maxdepth: 1 + + cli-manage-volumes + cli-set-quotas + cli-cinder-quotas + cli-cinder-scheduling diff --git a/doc/source/scheduler-filters.rst b/doc/source/configuration/block-storage/scheduler-filters.rst similarity index 100% rename from doc/source/scheduler-filters.rst rename to doc/source/configuration/block-storage/scheduler-filters.rst diff --git a/doc/source/scheduler-weights.rst b/doc/source/configuration/block-storage/scheduler-weights.rst similarity index 100% rename from doc/source/scheduler-weights.rst rename to doc/source/configuration/block-storage/scheduler-weights.rst diff --git a/doc/source/configuration/block-storage/schedulers.rst b/doc/source/configuration/block-storage/schedulers.rst index ada0d2b8a41..4d7f356a237 100644 --- a/doc/source/configuration/block-storage/schedulers.rst +++ b/doc/source/configuration/block-storage/schedulers.rst @@ -5,7 +5,10 @@ Block Storage schedulers Block Storage service uses the ``cinder-scheduler`` service to determine how to dispatch block storage requests. -For more information, see `Cinder Scheduler Filters -`_ -and `Cinder Scheduler Weights -`_. +For more information, see: + +.. toctree:: + :maxdepth: 1 + + Cinder Scheduler Filters + Cinder Scheduler Weights diff --git a/doc/source/index.rst b/doc/source/index.rst index 1b76aed60c5..11fa4258fb5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,94 +28,74 @@ Cinder is an OpenStack project to provide "block storage as a service". * **Open Standards**: Be a reference implementation for a community-driven api This documentation is generated by the Sphinx toolkit and lives in the source -tree. Additional draft and project documentation on Cinder and other components of OpenStack can -be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstack.org`_. +tree. Additional draft and project documentation on Cinder and other components +of OpenStack can be found on the `OpenStack wiki`_. Cloud administrators, refer +to `docs.openstack.org`_. .. _`OpenStack wiki`: https://wiki.openstack.org/wiki/Main_Page .. _`docs.openstack.org`: https://docs.openstack.org -Installing Cinder -~~~~~~~~~~~~~~~~~ - -To get started installing Cinder for use, start with the following documentation. +Installation Guide +~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 - install/index + Installation Guide + Upgrade Process -Admin Docs -~~~~~~~~~~ - -Administrators will find helpful information in the following links including a -description of how Cinder works, manages storage and how to troubleshoot your -Cinder installation. +Administration Guide +~~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 admin/index +Configuration Reference +~~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + configuration/index + + Sample Configuration File + + drivers + +CLI Reference +~~~~~~~~~~~~~ + +Information on the commands available through Cinder's Command Line +Interface (CLI) can be found in this section of documentation. + +Full documentation on the python-cinderclient is in the +`python-cinderclient documentation`_. + +.. _`python-cinderclient documentation`: https://docs.openstack.org/python-cinderclient/latest + +.. toctree:: + :maxdepth: 2 + + cli/index + cinder-manage Usage + Contributor/Developer Docs ~~~~~~~~~~~~~~~~~~~~~~~~~~ -The following links contained information for contributors and developers. -There is information on setting up a development environment, a lit of our API -information on how to add a driver and many other resources related to -contributing to Cinder. - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 contributor/index - scheduler-filters - scheduler-weights - upgrade -Command Line Interface Documentation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Information on the commands available through Cinder's Command Line -Interface (CLI) can be found in this section of documentation. Full documentation -on the python-cinderclient is in the `python-cinderclient repo`_. - -.. _`python-cinderclient repo`: https://docs.openstack.org/python-cinderclient/latest - -.. toctree:: - :maxdepth: 2 - - cli/cli-manage-volumes - cli/cli-set-quotas - cli/cli-cinder-quotas - cli/cli-cinder-scheduling - -Man Pages -~~~~~~~~~ - -Additional 'man page' style documentation for Cinder may be seen below. - -.. toctree:: - :maxdepth: 2 - - man/cinder-manage - -Drivers -~~~~~~~ - -Cinder maintains drivers for volume backends, backup targets, and fibre -channel zone manager fabric types. The list of the available drivers can be -found here: - -.. toctree:: - :maxdepth: 1 - - drivers API Extensions ~~~~~~~~~~~~~~ -Go to https://developer.openstack.org/api-ref/block-storage/ for information about Cinder API extensions. +Go to https://developer.openstack.org/api-ref/block-storage/ for information +about Cinder API extensions. :doc:`Block Storage v3 API Microversion History `: The block storage v3 API evolves over time through @@ -123,18 +103,6 @@ The block storage v3 API evolves over time through provides the history of all those changes. Consider it a "what's new" in the block storage v3 API. -Configuration Reference -~~~~~~~~~~~~~~~~~~~~~~~ - -The following links provide information on the many configuration options -available for Cinder including a sample configuration file. - -.. toctree:: - :maxdepth: 1 - - configuration/index - sample_config - Indices and tables ~~~~~~~~~~~~~~~~~~