reorganize existing documentation according to the new standard layout

Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-06-13 15:55:33 -04:00 committed by Andreas Jaeger
parent 19c8cabeca
commit 9599ffe65d
119 changed files with 78 additions and 45 deletions

View File

@ -1,3 +1,5 @@
.. _authentication:
============== ==============
Authentication Authentication
============== ==============

View File

@ -10,8 +10,8 @@ Should positional arguments for a command need to change, the OpenStackClient
team attempts to make the transition as painless as possible. Look for team attempts to make the transition as painless as possible. Look for
deprecation warnings that indicate the new commands (or options) to use. deprecation warnings that indicate the new commands (or options) to use.
Commands labeled as a beta according to :doc:`command-beta` are exempt from Commands labeled as a beta according to :ref:`command-beta` are exempt
this backwards incompatible change handling. from this backwards incompatible change handling.
Backwards Incompatible Changes Backwards Incompatible Changes
============================== ==============================

View File

@ -1,3 +1,5 @@
.. _command-list:
============ ============
Command List Command List
============ ============

View File

@ -4,6 +4,8 @@ configuration
Available for all services Available for all services
.. _configuration-show:
configuration show configuration show
------------------ ------------------

View File

@ -1,3 +1,5 @@
.. _command-structure:
================= =================
Command Structure Command Structure
================= =================
@ -162,9 +164,10 @@ referring to both Compute and Volume quotas.
Plugin Objects Plugin Objects
-------------- --------------
The following are known `Objects` used by OpenStack :doc:`plugins`. These are The following are known `Objects` used by OpenStack
listed here to avoid name conflicts when creating new plugins. For a complete :ref:`plugins`. These are listed here to avoid name
list check out :doc:`plugin-commands`. conflicts when creating new plugins. For a complete list check out
:ref:`plugin-commands`.
* ``action definition``: (**Workflow Engine (Mistral)**) * ``action definition``: (**Workflow Engine (Mistral)**)
* ``action execution``: (**Workflow Engine (Mistral)**) * ``action execution``: (**Workflow Engine (Mistral)**)
@ -281,7 +284,7 @@ Implementation
The command structure is designed to support seamless addition of plugin The command structure is designed to support seamless addition of plugin
command modules via ``setuptools`` entry points. The plugin commands must command modules via ``setuptools`` entry points. The plugin commands must
be subclasses of Cliff's ``command.Command`` object. See :doc:`plugins` for be subclasses of Cliff's ``command.Command`` object. See :ref:`plugins` for
more information. more information.

Some files were not shown because too many files have changed in this diff Show More