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:
parent
19c8cabeca
commit
9599ffe65d
doc/source/cli
authentication.rstbackwards-incompatible.rstcommand-list.rst
command-objects
access-token.rstaddress-scope.rstaggregate.rstavailability-zone.rstbackup.rstcatalog.rstcommand.rstcomplete.rstcompute-agent.rstcompute-service.rstconfiguration.rstconsistency-group-snapshot.rstconsistency-group.rstconsole-log.rstconsole-url.rstconsumer.rstcontainer.rstcredential.rstdomain.rstec2-credentials.rstendpoint.rstextension.rstfederation-protocol.rstflavor.rstfloating-ip-pool.rstfloating-ip.rstgroup.rsthost.rsthypervisor-stats.rsthypervisor.rstidentity-provider.rstimage.rstip-availability.rstip-fixed.rstip-floating-pool.rstip-floating.rstkeypair.rstlimits.rstmapping.rstmodule.rstnetwork-agent.rstnetwork-auto-allocated-topology.rstnetwork-flavor-profile.rstnetwork-flavor.rstnetwork-meter-rule.rstnetwork-meter.rstnetwork-qos-policy.rstnetwork-qos-rule-type.rstnetwork-qos-rule.rstnetwork-rbac.rstnetwork-segment.rstnetwork-service-provider.rstnetwork.rstobject-store-account.rstobject.rstpolicy.rstport.rstproject-purge.rstproject.rstquota.rstregion.rstrequest-token.rstrole-assignment.rstrole.rstrouter.rstsecurity-group-rule.rstsecurity-group.rstserver-backup.rstserver-event.rstserver-group.rstserver-image.rstserver.rstservice-provider.rstservice.rstsnapshot.rstsubnet-pool.rstsubnet.rsttoken.rsttrust.rstusage.rstuser-role.rstuser.rstvolume-backup.rstvolume-host.rstvolume-qos.rstvolume-service.rstvolume-snapshot.rstvolume-transfer-request.rstvolume-type.rstvolume.rst
commands.rstdata
@ -1,3 +1,5 @@
|
||||
.. _authentication:
|
||||
|
||||
==============
|
||||
Authentication
|
||||
==============
|
@ -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
|
||||
deprecation warnings that indicate the new commands (or options) to use.
|
||||
|
||||
Commands labeled as a beta according to :doc:`command-beta` are exempt from
|
||||
this backwards incompatible change handling.
|
||||
Commands labeled as a beta according to :ref:`command-beta` are exempt
|
||||
from this backwards incompatible change handling.
|
||||
|
||||
Backwards Incompatible Changes
|
||||
==============================
|
@ -1,3 +1,5 @@
|
||||
.. _command-list:
|
||||
|
||||
============
|
||||
Command List
|
||||
============
|
0
doc/source/command-objects/compute-service.rst → doc/source/cli/command-objects/compute-service.rst
0
doc/source/command-objects/compute-service.rst → doc/source/cli/command-objects/compute-service.rst
@ -4,6 +4,8 @@ configuration
|
||||
|
||||
Available for all services
|
||||
|
||||
.. _configuration-show:
|
||||
|
||||
configuration show
|
||||
------------------
|
||||
|
0
doc/source/command-objects/ec2-credentials.rst → doc/source/cli/command-objects/ec2-credentials.rst
0
doc/source/command-objects/ec2-credentials.rst → doc/source/cli/command-objects/ec2-credentials.rst
0
doc/source/command-objects/ip-availability.rst → doc/source/cli/command-objects/ip-availability.rst
0
doc/source/command-objects/ip-availability.rst → doc/source/cli/command-objects/ip-availability.rst
0
doc/source/command-objects/network-segment.rst → doc/source/cli/command-objects/network-segment.rst
0
doc/source/command-objects/network-segment.rst → doc/source/cli/command-objects/network-segment.rst
0
doc/source/command-objects/role-assignment.rst → doc/source/cli/command-objects/role-assignment.rst
0
doc/source/command-objects/role-assignment.rst → doc/source/cli/command-objects/role-assignment.rst
0
doc/source/command-objects/volume-snapshot.rst → doc/source/cli/command-objects/volume-snapshot.rst
0
doc/source/command-objects/volume-snapshot.rst → doc/source/cli/command-objects/volume-snapshot.rst
@ -1,3 +1,5 @@
|
||||
.. _command-structure:
|
||||
|
||||
=================
|
||||
Command Structure
|
||||
=================
|
||||
@ -162,9 +164,10 @@ referring to both Compute and Volume quotas.
|
||||
Plugin Objects
|
||||
--------------
|
||||
|
||||
The following are known `Objects` used by OpenStack :doc:`plugins`. These are
|
||||
listed here to avoid name conflicts when creating new plugins. For a complete
|
||||
list check out :doc:`plugin-commands`.
|
||||
The following are known `Objects` used by OpenStack
|
||||
:ref:`plugins`. These are listed here to avoid name
|
||||
conflicts when creating new plugins. For a complete list check out
|
||||
:ref:`plugin-commands`.
|
||||
|
||||
* ``action definition``: (**Workflow Engine (Mistral)**)
|
||||
* ``action execution``: (**Workflow Engine (Mistral)**)
|
||||
@ -281,7 +284,7 @@ Implementation
|
||||
|
||||
The command structure is designed to support seamless addition of plugin
|
||||
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.
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user