openstack
/
python-openstackclient
Code Issues Proposed changes
python-openstackclient/doc/source/cli/command-objects
History
Eric Fried 26878e7d53 identity: autogenerate docs 
$namespace = openstack.identity.v{2|3}

The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.

Special things:

- Some reorganization happened here. Certain subcommand names, such as
  `endpoint` and `project`, are shared by identify v2 and v3. Previously
  the hardcoded documents had them combined and interleaved. Attempting
  to preserve this with autoprogram-cliff would have required
  significant additional infrastructure. However, since most readers
  care completely about one and not at all about the other, we instead
  split the v2 and v3 versions of these commands into separate pages. In
  case links to the old pages exist in the wild, they are preserved, but
  moved (with redirects) to a hidden directory, and populated simply
  with links to the new version-specific generated documents.

- The `federation domain` and `federation project` subcommands were
  previously absent from the docs. They are added. These are such small
  commands and they seem related, so they're put into a single document.

- Some pages were already being generated but were listing operations
  individually instead of using wildcards (possibly because they were
  created before wildcarding was supported by cliff). These are changed
  to use wildcarding. (We want to do this wherever possible as it is
  more future-proof in the event that more operations are added to a
  subcommand later.)

- The `service provider` document was incorrectly titled `identity
  provider`. Fixed.

Change-Id: I2030f9fe370038c5908b6eb6bed9692a73fe5067
 		2020-06-08 16:34:27 -05:00
..
access-rules.rst Add support for app cred access rules 2020-01-17 11:14:51 -08:00
access-token.rst auto-generate docs for v3 identity resources 2017-10-06 00:57:04 +00:00
address-scope.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
aggregate.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
application-credentials.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
availability-zone.rst common: autogenerate docs 2019-11-05 07:09:05 -06:00
catalog.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
command.rst openstack.cli: autogenerate docs 2019-11-05 07:09:05 -06:00
complete.rst Improve document 'openstack complete' 2018-10-19 09:20:37 +10:00
compute-agent.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
compute-service.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
configuration.rst common: autogenerate docs 2019-11-05 07:09:05 -06:00
consistency-group-snapshot.rst reorganize existing documentation according to the new standard layout 2017-06-23 11:54:32 +02:00
consistency-group.rst reorganize existing documentation according to the new standard layout 2017-06-23 11:54:32 +02:00
console-log.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
console-url.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
consumer.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
container.rst auto-generate object docs 2017-08-17 16:46:31 -04:00
credential.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
domain.rst auto-generate docs for v3 identity resources 2017-10-06 00:57:04 +00:00
ec2-credentials-v2.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
ec2-credentials-v3.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
endpoint-v2.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
endpoint-v3.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
endpoint_group.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
extension.rst common: autogenerate docs 2019-11-05 07:09:05 -06:00
federation-domain-project.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
federation-protocol.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
flavor.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
floating-ip-pool.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
floating-ip-port-forwarding.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
floating-ip.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
group.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
host.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
hypervisor-stats.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
hypervisor.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
identity-provider.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
image.rst Merge "Add possibility to filter images using member_status" 2019-03-07 00:34:17 +00:00
implied_role.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
ip-availability.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
keypair.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
limit.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
limits.rst common: autogenerate docs 2019-11-05 07:09:05 -06:00
mapping.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
module.rst openstack.cli: autogenerate docs 2019-11-05 07:09:05 -06:00
network-agent.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-auto-allocated-topology.rst Update a stale doc reference to use :neutron-doc: 2019-11-05 07:09:05 -06:00
network-flavor-profile.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-flavor.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-meter-rule.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-meter.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-qos-policy.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-qos-rule-type.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-qos-rule.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-rbac.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-segment.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network-service-provider.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
network_segment_range.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
object-store-account.rst auto-generate object docs 2017-08-17 16:46:31 -04:00
object.rst auto-generate object docs 2017-08-17 16:46:31 -04:00
policy.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
port.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
project-purge.rst common: autogenerate docs 2019-11-05 07:09:05 -06:00
project-v2.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
project-v3.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
quota.rst common: autogenerate docs 2019-11-05 07:09:05 -06:00
region.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
registered-limit.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
request-token.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
role-assignment.rst reorganize existing documentation according to the new standard layout 2017-06-23 11:54:32 +02:00
role-v2.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
role-v3.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
router.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
security-group-rule.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
security-group.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
server-backup.rst Convert 'server' commands to use autoprogram 2017-10-26 09:34:04 +00:00
server-event.rst Convert 'server' commands to use autoprogram 2017-10-26 09:34:04 +00:00
server-group.rst Convert 'server' commands to use autoprogram 2017-10-26 09:34:04 +00:00
server-image.rst Convert 'server' commands to use autoprogram 2017-10-26 09:34:04 +00:00
server.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
service-provider.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
service-v2.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
service-v3.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
subnet-pool.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
subnet.rst neutron: autogenerate docs 2019-11-01 14:24:30 -05:00
token-v2.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
token-v3.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
trust.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
usage.rst compute: autogenerate docs 2019-11-05 07:09:05 -06:00
user-v2.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
user-v3.rst identity: autogenerate docs 2020-06-08 16:34:27 -05:00
versions.rst common: autogenerate docs 2019-11-05 07:09:05 -06:00
volume-backend.rst Add volume backend capability show command 2018-10-09 15:31:35 -05:00
volume-backup.rst Add volume backup import/export commands 2018-11-10 02:11:04 -06:00
volume-host.rst reorganize existing documentation according to the new standard layout 2017-06-23 11:54:32 +02:00
volume-qos.rst reorganize existing documentation according to the new standard layout 2017-06-23 11:54:32 +02:00
volume-service.rst reorganize existing documentation according to the new standard layout 2017-06-23 11:54:32 +02:00
volume-snapshot.rst Fix faulthy state argument choice 2019-12-19 09:48:17 +01:00
volume-transfer-request.rst reorganize existing documentation according to the new standard layout 2017-06-23 11:54:32 +02:00
volume-type.rst Update help text for encryption provider 2018-02-23 16:26:39 -05:00
volume.rst Add --attached / --detached parameter to volume set 2019-02-28 15:48:34 +00:00