openstack/cinder
Code Issues Proposed changes
cinder/doc/source/contributor
History
Gorka Eguileor 2f0bd74604 Fix get_driver_options 
Any new Cinder driver we add that doesn't have the "get_driver_options"
method defined will break the driver list generation tools.

The reason why it breaks them is because this method must be static, yet
our base driver class doesn't define it as static.

This patch:

- Sets the base method as static to prevent new drivers from breaking
  the tools.

- Documents the existence of this method for driver developers.

- Adds get_driver_options method for drivers that are missing it.

- Fix macrosan_client help message that breaks the doc building process.

Closes-Bug: #1838225
Change-Id: I4797724d7b55709f0903d522b0233242b867146d
2019-07-31 20:24:52 +02:00
..
addmethod.openstackapi.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
api_conditional_updates.rst
Fix the typo in api_conditional_updates.rst
2018-01-31 19:50:36 +08:00
api_microversion_dev.rst
Drop use of git.openstack.org
2019-04-16 08:44:22 -05:00
api_microversion_history.rst
Make doc/source directory compliant with design in spec
2017-07-19 15:59:02 -05:00
api.apache.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
architecture.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
attach_detach_conventions_v2.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
attach_detach_conventions.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
development.environment.rst
Small doc updates: canonical URLs, rally doc, etc
2019-06-04 17:57:16 +02:00
documentation.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
drivers_locking_examples.rst
Remove DataCore volume drivers
2019-04-10 11:29:37 -05:00
drivers.rst
Fix get_driver_options
2019-07-31 20:24:52 +02:00
gerrit.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
gmr.rst
Update and replace http with https for doc links in Cinder
2017-07-27 09:58:23 +00:00
groups.rst
Remove support for NetApp E-Series systems
2018-12-28 11:19:32 -02:00
high_availability.rst
Small doc updates: canonical URLs, rally doc, etc
2019-06-04 17:57:16 +02:00
i18n.rst
Update and replace http with https for doc links in Cinder
2017-07-27 09:58:23 +00:00
index.rst
Start release cycle checklist documentation
2019-04-19 09:31:58 -05:00
jenkins.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
launchpad.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
migration.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
new_driver_checklist.rst
Docs: Add new driver review checklist
2019-05-31 15:53:14 -05:00
README.rst
Fix some typos in cinder doc
2017-12-19 13:47:45 +08:00
releasecycle.rst
Start release cycle checklist documentation
2019-04-19 09:31:58 -05:00
releasenotes.rst
Update and replace http with https for doc links in Cinder
2017-07-27 09:58:23 +00:00
replication.rst
Update doc for missed quotation marks
2019-05-10 08:46:16 +00:00
rolling.upgrades.rst
Add Contributor Docs for Upgrade Checks
2019-06-07 13:46:31 -05:00
rpc.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
testing.rst
Update unit test debugging instructions for stestr
2019-04-22 09:20:33 -05:00
thin_provisioning.rst
Updates overprovisioning dev-ref
2018-04-27 15:03:32 -03:00
threading.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
user_messages.rst
Document behavior of message.create
2019-04-04 10:27:12 -04:00

README.rst

Cinder Contributor Documentation (source/contributor)

Introduction:

This directory is intended to hold any documentation that relates to how to contribute to Cinder or how the project is managed. Some of this content was previous under 'developer' in openstack-manuals. The content of the documentation, however, goes beyond just developers to anyone contributing to the project, thus the change in naming.

The full spec for organization of documentation may be seen in the OS Manuals Migration Spec <https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html>.