12 Commits

Author SHA1 Message Date
wangxiyuan
9df0bce1d0 [doc] Update doc index
1. The commit[1] added the "attach_detach_conventions_v2" doc file,
but it missed to be shown in the index.
2. The commit[2] removed "database_architecture" and "oslo-middleware"
files from doc. So we should remove them from the index as well.

[1]: Ie15233c99d91de67279b56d27a5508c5ea98d769
[2]: I145464d0d63cb5a00e0e905083c260fb6621dd89

Change-Id: I077a9d522eee06c864f1458878a794548ed93584
2017-03-22 11:28:33 +08:00
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
Jenkins
c47d38dc94 Merge "Add driver list to doc build" 2016-07-29 02:24:22 +00:00
Sean McGinnis
8148038e92 Add driver list to doc build
We have tox -e gendriverlist that outputs an RST-ish report of all drivers
in the tree. This output can be used in the docs build to automatically
publish the list of drivers to make it easier to find officially supported
drivers.

This effectively removes the existing drivers.html that was generated prior
that did not actually contain any useful information.

Change-Id: I8de78723af76aabcc976733ac4b248db0b8ca16f
2016-07-26 11:09:05 -05:00
Sean McGinnis
14f378a580 Docs: remove todo list generation
We had an extension for pulling out todo information from our docs. This
doesn't appear to have ever really been used though. Only a couple todo items
were published to the Cinder documentation, and the two published appear to
be extremely old.

Since this isn't really used and could just cause confusion, removing this
from the index page and removing the sphinx extension used to generate it.

Change-Id: I8993633538a5ee1687c4721bce3c520e8fb4ccfd
2016-07-23 18:15:42 -05:00
Sean McGinnis
fcd7fcea3e Add sample config file to cinder docs
The oslo sphinxconfiggen module was added to the oslo.config
2.3.0 release. This enables config file generation as part of
the sphinx doc generation.

The generated config file will pick up the current config
options from the code base. And as an added bonus, it will
now be published to the docs.openstack.org site for easy
reference or download.

This also puts us inline with what other projects like Nova
are doing for sample config files and is the recommended
method from the Oslo team.

Change-Id: I912a97eb2686d3dc56e50d8641d7bd930179bc18
2016-05-17 08:52:21 -05:00
Craige McWhirter
1b5f47414d Create a page of drivers with stevedore.sphinxext
As per:
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html

The point behind the addition of the stevedore.sphinxext extension is
"to document drivers and other types of plugins to make the available
sets built into projects easier to discover" (dhellman).

Change-Id: I8427398e8d01c36f346e493a8144c1012ca7c5bf
2015-09-15 15:54:34 +10:00
Ivan Kolodyazhny
063cc75c87 Remove obsolete API from documentation
Cinder doesn't support EC2 API and doesn't contain cinder.api.ec2
module.
Also references to cinder.api.openstack.auth and cinder.api.cloud were
removed too.

Change-Id: I30f71cf541d93d3ab68780328e2dea6ebd326b63
2015-07-14 18:57:19 +03:00
Doug Hellmann
17e8d9cf8a Fix a few Sphinx warnings
Corrects some rst formatting to eliminate warnings in
the documenation build.

Change-Id: I4026a1c8e7fae1928ca50d80aa1b5440faf754da
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2013-07-05 16:09:50 -04:00
John Griffith
922fdd0bdc Update dev docs
* Quick pass at implementing the basics for cinder dev docs
  * Remove the N/A compute related stuff
  * Clean up the architecture a bit to only show cinder related
  * Remove various modules form TOC's that aren't applicable

Change-Id: I0089c388524c9def7494658e836f4ed03a61f5b5
2012-09-03 17:18:10 -06:00
John Griffith
c3bc1aa3a6 Do not duplicate nova docs in cinder
* This modifies the index.rst file to give interim info about cinder
* We were regenerating the nova docs copied over which was bad!
* Fixes bug 1022315

Change-Id: I46531976f3e6521cec69cc13276d328d6c2d2da3
2012-07-12 13:11:54 -06:00
Jenkins
c53d8e343e Initial fork out of Nova. 2012-05-03 10:48:26 -07:00