1423480fb6
The following spec defines what each project's doc/source directory is supposed to look like: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html I had not yet moved existing content to follow this design. This patch does that, moving the devref to the 'contributor' directory. It also moves the CLI related documentation into the 'cli' directory. I have updated the autodoc generation to now create the api documentation in 'doc/source/contributor/api'. This patch also creates a template for future documentation contribution. I have created all of the directories recommended by the spec and have included documentation as to what should go in each directory. The index file is updated to point at the new locations for existing content. 'doc/.gitignore' is updated so that it won't complain about the automatically generated 'doc/contributor/api' directory. Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
658 B
658 B
Cinder CLI Documentation
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>.