Make Cinder's Landing Page look like Keystone's

The index.rst page for Cinder was not well suited
to the new openstackdocstheme that was created.  This
resulted in the page just looking like a disorganized
set of links with no visually defined topics or
explanation.

With this patch I emulate the look of the Keystone page
by properly indicating the different topics in the page
and add some text to describe each of the sections.  I also
update some of the old 'Block Storage' pages to use a 'Cinder'
heading for consistency.

Change-Id: I341e8340b960946a86f4ff8fbee3624531b375af
This commit is contained in:
Jay S. Bryant
2017-08-07 14:11:53 -05:00
parent 2a27fe404a
commit b156d24b6e
3 changed files with 39 additions and 17 deletions

View File

@@ -1,8 +1,8 @@
.. _block_storage:
=============
Block Storage
=============
=====================
Cinder Administration
=====================
The OpenStack Block Storage service works through the interaction of
a series of daemon processes named ``cinder-*`` that reside

View File

@@ -1,6 +1,6 @@
===================================
Block Storage Service Configuration
===================================
============================
Cinder Service Configuration
============================
.. toctree::
:maxdepth: 1

View File

@@ -15,8 +15,9 @@
License for the specific language governing permissions and limitations
under the License.
Welcome to Cinder's developer documentation!
============================================
===========================================
Cinder, the OpenStack Block Storage Service
===========================================
Cinder is an OpenStack project to provide "block storage as a service".
@@ -35,7 +36,9 @@ be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstac
Installing Cinder
=================
~~~~~~~~~~~~~~~~~
To get started installing Cinder for use, start with the following documentation.
.. toctree::
:maxdepth: 2
@@ -43,14 +46,24 @@ Installing Cinder
install/index
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.
.. toctree::
:maxdepth: 2
admin/blockstorage
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
@@ -61,7 +74,13 @@ Contributor/Developer Docs
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
@@ -72,7 +91,7 @@ Command Line Interface Documentation
cli/cli-cinder-scheduling
Drivers
=======
~~~~~~~
Cinder maintains drivers for volume backends, backup targets, and fibre
channel zone manager fabric types. The list of the available drivers can be
@@ -84,12 +103,15 @@ found here:
drivers
API Extensions
==============
~~~~~~~~~~~~~~
Go to http://api.openstack.org for information about Cinder API extensions.
Configuration Reference
=======================
~~~~~~~~~~~~~~~~~~~~~~~
The following links provide information on the many configuration options
available for Cinder including a sample configuration file.
.. toctree::
:maxdepth: 1
@@ -98,14 +120,14 @@ Configuration Reference
sample_config
Indices and tables
==================
~~~~~~~~~~~~~~~~~~
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Glossary
========
~~~~~~~~
.. toctree::
:maxdepth: 1