Merge "Make Cinder's Landing Page look like Keystone's"

This commit is contained in:
Jenkins
2017-08-07 21:48:35 +00:00
committed by Gerrit Code Review
3 changed files with 39 additions and 17 deletions

View File

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

View File

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

View File

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