openstack/cinder
Code Issues Proposed changes
8881599184
cinder/doc/source/cli/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

693 B
Raw Blame History

Cinder CLI Documentation (source/cli)

Introduction:

This directory is intended to hold any documentation that relates to Cinder's Command Line Interface. Note that this directory is intended for basic descriptions of the commands supported, similar to what you would find with a 'man page'. Tutorials or step-by-step guides should go into 'doc/source/admin' or 'doc/source/user' depending on the target audience.

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