openstack/cinder
Code Issues Proposed changes
04b6700f48
cinder/doc/source/contributor
History
Gorka Eguileor 2707632147 Doc: Improve name_id documentation 
Currently our code and contributor documentation doesn't mention the
difference between the two different UUIDs we can have and how drivers
should use them.

This patch tries to provide a brief description about it in multiple
places to reduce the number of bugs that happen around it.

Change-Id: I946ead7547571ccd1b2df55ac1f3d4689d1f8089
2022-05-12 19:54:03 +02:00
..
addmethod.openstackapi.rst
Remove Block Storage API v2
2021-06-04 17:21:28 -04: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
Update volume api microversion doc and tests
2021-05-31 12:41:46 +02: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
docs: update cinder system architecture page
2019-10-17 03:01:08 +05:30
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
backporting.rst
Add statement about CI for backports
2022-04-20 12:50:24 -04:00
cinder-groups.rst
[docs] Update cinder-stable-maint description
2022-04-01 16:19:45 -04:00
contributing.rst
docs: Update "Getting your patch merged"
2022-02-03 18:54:01 -05:00
database-migrations.rst
db: Enable auto-generation of database migrations
2022-02-20 19:06:01 +00:00
development.environment.rst
Update Development Environment documentation for Ubuntu
2020-11-03 14:01:41 +02:00
documentation.rst
Update doc contributor doc
2020-11-16 10:07:17 -05:00
drivers_locking_examples.rst
Rename Dell EMC to Dell
2022-04-25 07:28:45 -07:00
drivers.rst
Doc: Improve name_id documentation
2022-05-12 19:54:03 +02:00
gerrit.rst
Add review best practices section
2022-04-22 16:57:32 +05:30
gmr.rst
Update and replace http with https for doc links in Cinder
2017-07-27 09:58:23 +00:00
groups.rst
docs: Remove unnecessary 'blockstorage-' prefix
2022-02-20 19:06:32 +00:00
high_availability.rst
Remove file locks once we delete a resource
2021-08-04 10:41:33 -04:00
i18n.rst
Docs: Jenkins is dead, long live Zuul
2019-08-13 21:06:27 +02:00
index.rst
[doc] Add info about backport policies
2022-03-23 09:10:02 -04:00
launchpad.rst
Docs: Jenkins is dead, long live Zuul
2019-08-13 21:06:27 +02:00
migration.rst
Fix example of failed migrarion for LVM->RBD
2022-04-29 17:47:24 +03:00
new_driver_checklist.rst
Doc: Improve name_id documentation
2022-05-12 19:54:03 +02:00
README.rst
Fix some typos in cinder doc
2017-12-19 13:47:45 +08:00
releasecycle.rst
[doc] update releasecycle tasks
2022-04-22 08:54:38 -04:00
releasenotes.rst
Add reviewing section to release notes doc
2021-09-23 12:49:28 -04:00
replication.rst
Update doc for missed quotation marks
2019-05-10 08:46:16 +00:00
rolling.upgrades.rst
Fix duplicated words issue like " should should "
2020-01-06 10:53:18 +08:00
rpc.rst
Doc8: Stop skipping D001: Line too long
2019-02-19 16:51:56 -06:00
testing.rst
Ussuri contrib docs community goal
2020-03-05 14:11:48 -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
zuul.rst
Docs: Jenkins is dead, long live Zuul
2019-08-13 21:06:27 +02: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>.