Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 5ad4617

Browse filesBrowse files
stephenfinstephenfin
committed
docs: Restructure command-objects guide
These docs were initially structured based on the idea that commands should be common across service versions. This has unfortunately broken down over time and is no longer true, with an increasingly large divergence between API implementations. Start splitting the docs out by service version to bypass this. Redirects are added to ensure we don't break any existing links in the wild. Change-Id: Iaf42bc5b92c811a42cbe450d21fdb5ae00f6f45b Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
1 parent 0fc7b72 commit 5ad4617
Copy full SHA for 5ad4617

151 files changed

+1,782-1,727Lines changed: 1782 additions & 1727 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎doc/source/_extra/.htaccess‎

Copy file name to clipboardExpand all lines: doc/source/_extra/.htaccess
+10Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,13 @@ redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/plugin-commands.html$ /py
1414
# - image pages were split into -v1 and -v2
1515
# The unversioned page is hidden but contains links to the versioned pages so links in the wild redirect somewhere sane.
1616
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(ec2-credentials|endpoint|image|project|role|service|token|user).html$ /python-openstackclient/$1/cli/_hidden/$2.html
17+
18+
# Redirect docs from their previous flat structure to the new service/version structure
19+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(availability-zone|command|complete|configuration|extension|limits|module|project-cleanup|quota|versions)\.html$ /python-openstackclient/$1/cli/command-objects/common/index.html
20+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(aggregate|compute-agent|compute-service|console-connection|console-log|console-url|flavor|host|hypervisor-stats|hypervisor|keypair|server-backup|server-event|server-group|server-image|server-migration|server|usage)\.html$ /python-openstackclient/$1/cli/command-objects/compute/v2/index.html
21+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(ec2-credentials-v2|endpoint-v2|project-v2|role-v2|service-v2|token-v2|user-v2)\.html$ /python-openstackclient/$1/cli/command-objects/identity/v2/index.html
22+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(access-rules|access-token|application-credentials|catalog|consumer|credential|domain|ec2-credentials-v3|endpoint-v3|endpoint_group|federation-domain-project|federation-protocol|group|identity-provider|implied_role|limit|mapping|policy|project-v3|region|registered-limit|request-token|role-assignment|role-v3|service-provider|service-v3|token-v3|trust|user-v3)\.html$ /python-openstackclient/$1/cli/command-objects/identity/v3/index.html
23+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(image-member|image-task|image-v2)\.html$ /python-openstackclient/$1/cli/command-objects/image/v2/index.html
24+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(address-group|address-scope|default-security-group-rule|floating-ip-port-forwarding|floating-ip|ip-availability|local-ip-association|local-ip|network-agent|network-auto-allocated-topology|network-flavor-profile|network-flavor|network-l3-conntrack-helper|network-meter-rule|network-meter|network-qos-policy|network-qos-rule-type|network-qos-rule|network-rbac|network-segment|network-service-provider|network-trunk|network|network_segment_range|port|router-ndp-proxy|router|security-group-rule|security-group|subnet-pool|subnet)\.html$ /python-openstackclient/$1/cli/command-objects/network/v2/index.html
25+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(container|object-store-account|object)\.html$ /python-openstackclient/$1/cli/command-objects/object-store/v1/index.html
26+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(block-storage-cleanup|block-storage-cluster|block-storage-log-level|block-storage-manage|block-storage-resource-filter|consistency-group-snapshot|consistency-group|volume-attachment|volume-backend|volume-backup|volume-group-snapshot|volume-group-type|volume-group|volume-host|volume-message|volume-qos|volume-service|volume-snapshot|volume-transfer-request|volume-type|volume)\.html$ /python-openstackclient/$1/cli/command-objects/volume/v3/index.html
Collapse file

‎doc/source/cli/_hidden/ec2-credentials.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/ec2-credentials.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/_hidden/endpoint.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/endpoint.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/_hidden/image.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/image.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/_hidden/project.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/project.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/_hidden/role.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/role.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/_hidden/service.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/service.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/_hidden/token.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/token.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/_hidden/user.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/_hidden/user.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.
Collapse file

‎doc/source/cli/command-list.rst‎

Copy file name to clipboardExpand all lines: doc/source/cli/command-list.rst
+21-1Lines changed: 21 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,24 @@ Command List
88
:glob:
99
:maxdepth: 2
1010

11-
command-objects/*
11+
command-objects/common/index
12+
command-objects/compute/v2/index
13+
command-objects/identity/v2/index
14+
command-objects/identity/v3/index
15+
command-objects/image/v1/index
16+
command-objects/image/v2/index
17+
command-objects/network/v2/index
18+
command-objects/object-store/v1/index
19+
command-objects/share/v2/index
20+
command-objects/volume/v2/index
21+
command-objects/volume/v3/index
22+
23+
.. toctree::
24+
:hidden:
25+
26+
command-objects/identity/index
27+
command-objects/image/index
28+
command-objects/network/index
29+
command-objects/object-store/index
30+
command-objects/share/index
31+
command-objects/volume/index

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.