openstack/cinder
Code Issues Proposed changes
8e809d305c
cinder/doc/source/user/README.rst
Jay S. Bryant 79245a6283 [Docs] Add documentation contribution docs 
Now that we are in charge of managing our documentation I thought
we should have a section in the Contributor Guide on
how to contribute documentation.  This patch adds that.

It also resolves build WARNINGS due to the README files I added
not being included in any toctrees and adds the missing README
file to the install directory.

Change-Id: I8e12628b439a400ebd1ee6d691673a16e2c2f9d2
2017-08-10 15:52:46 -05:00

609 B
Raw Blame History

Cinder User Documentation (source/user)

Introduction:

This directory is intended to hold any documentation that helps Cinder end-users. This can include concept guides, tutorials, step-by-step guides for using the CLI, etc. Note that documentation this is focused on administrative actions should go into 'doc/source/admin'.

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