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

1.8 KiB

Raw Blame History

Contributor Guide

In this section you will find information on Cinder's lower level programming APIs.

Programming HowTos and Tutorials

development.environment api_microversion_dev api_conditional_updates api_microversion_history testing addmethod.openstackapi drivers gmr replication user_messages migration api.apache rolling.upgrades groups

Background Concepts for Cinder

architecture attach_detach_conventions attach_detach_conventions_v2 threading i18n rpc

Other Resources

launchpad gerrit jenkins releasenotes

API Reference

./api/autoindex

Module Reference

services database volume auth api scheduler fakes cinder

Indices and tables

genindex
modindex
search

1.8 KiB Raw Blame History