History

Michał Dulko fc0034b385 Rolling upgrade procedure documentation

One of the requirements to achieve assert:supports-rolling-upgrade TC
tag is to provide a "plan that allows operators to roll out new code to
subsets of services, eliminating the need to restart all services on new
code simultaneously".

This commit documents such rolling upgrade procedure in the devref,
which is last outstanding requirement for Cinder.

Change-Id: I562deafcd4bb9f5666cc35ae77a6bf20ab889612

2016-12-16 11:03:56 +01:00

ext

Merge "Add driver list to doc build"

2016-07-29 02:24:22 +00:00

source

Rolling upgrade procedure documentation

2016-12-16 11:03:56 +01:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

find_autodoc_modules.sh

Fixes a small issue in find_autodoc_modules.sh

2015-01-23 14:38:44 +08:00

generate_autodoc_index.sh

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

README.rst

Update doc README and remove old Makefile

2016-07-23 18:04:04 -05:00

README.rst

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

Developer documentation is built to: http://docs.openstack.org/developer/cinder/

Tools

Sphinx: The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.
Graphviz: Some of the diagrams are generated using the dot language from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs