openstack/cinder
Code Issues Proposed changes

Clean up docs landing page

Browse Source 
Reorganizes and cleans up the docs landing page so viewers eyes don't
immediately start bleeding. Also tries to simplify things and put them
in a more logical and consumable order.

Change-Id: I1c3ee6ad21bd27a5ef7f6691ddd8dde25e9c4c01
This commit is contained in:
Sean McGinnis 2017-10-03 13:08:33 -05:00
parent 3fa7070231
commit eca5f76927
5 changed files with 59 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/cli/index.rst Normal file
View File

@ -0,0 +1,11 @@
================================
Command-Line Interface Reference
================================
.. toctree::
:maxdepth: 1
cli-manage-volumes
cli-set-quotas
cli-cinder-quotas
cli-cinder-scheduling

0
doc/source/scheduler-filters.rst → doc/source/configuration/block-storage/scheduler-filters.rst
View File

0
doc/source/scheduler-weights.rst → doc/source/configuration/block-storage/scheduler-weights.rst
View File

11
doc/source/configuration/block-storage/schedulers.rst
View File

@ -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
<https://docs.openstack.org/cinder/latest/scheduler-filters.html>`_
and `Cinder Scheduler Weights
<https://docs.openstack.org/cinder/latest/scheduler-weights.html>`_.
For more information, see:
.. toctree::
:maxdepth: 1
Cinder Scheduler Filters <scheduler-filters>
Cinder Scheduler Weights <scheduler-weights>

114
doc/source/index.rst
View File

@ -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 <install/index>
Upgrade Process <upgrade>
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 <sample_config>
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 <man/cinder-manage>
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 </contributor/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
~~~~~~~~~~~~~~~~~~