Jay S. Bryant 1423480fb6 Make doc/source directory compliant with design in spec

The following spec defines what each project's doc/source
directory is supposed to look like:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory.  It also moves the CLI
related documentation into the 'cli' directory.  I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.

This patch also creates a template for future documentation
contribution.  I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.

The index file is updated to point at the new locations for
existing content.

'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.

Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6

2017-07-19 15:59:02 -05:00

2.6 KiB

Raw Blame History

Welcome to Cinder's developer documentation!

Cinder is an OpenStack project to provide "block storage as a service".

Component based architecture: Quickly add new behaviors
Highly available: Scale to very serious workloads
Fault-Tolerant: Isolated processes avoid cascading failures
Recoverable: Failures should be easy to diagnose, debug, and rectify
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.

Installing Cinder

install/index

Admin Docs

admin/blockstorage

Contributor/Developer Docs

contributor/index scheduler-filters scheduler-weights upgrade

Command Line Interface Documentation

cli/cli-manage-volumes cli/cli-set-quotas cli/cli-cinder-quotas 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 found here:

drivers

API Extensions

Go to http://api.openstack.org for information about Cinder API extensions.

Configuration Reference

configuration/block-storage sample_config

Indices and tables

genindex
modindex
search

2.6 KiB Raw Blame History