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.5 KiB

Raw Blame History

The Database Layer

The `cinder.db.api` Module

cinder.db.api

The Sqlalchemy Driver

The `cinder.db.sqlalchemy.api` Module

cinder.db.sqlalchemy.api

The `cinder.db.sqlalchemy.models` Module

cinder.db.sqlalchemy.models

Tests

Tests are lacking for the db api layer and for the sqlalchemy driver. Failures in the drivers would be detected in other test cases, though.

1.5 KiB Raw Blame History