delta/openstack/python-ironicclient.git/doc/source/cli, branch stable/stein

Allocation API: client API and CLI

2019-02-16T14:51:38+00:00

Adds the Python API to create/list/view/delete allocations, as well
as the OpenStackClient commands.

Change-Id: Ib97ee888c4a7b6dfa38934f02372284aa4c781a0
Story: #2004341
Task: #28028

[doc] Add 'openstack create' command to command reference

2018-03-14T15:43:30+00:00

This adds the 'openstack create' command to the Command Reference
section of the 'openstack baremetal CLI' documentation.

Change-Id: Id31e0c7d7f6dc15bfb22a337cfc4798b43c52327
Closes-Bug: #1755847

Deprecate the ironic CLI

2017-10-11T14:03:26+00:00

The 'ironic' CLI is being deprecated; it is slated for removal in the S*
release cycle. The 'openstack baremetal' CLI should be used instead.
A message is printed out to that effect and the documentation is
updated to reflect this.

Change-Id: Ie6ac3c6222ec6a6231b9a9cb2949cac56b48967f
Closes-Bug: 1700815

Update documentation

2017-10-03T14:12:29+00:00

This updates the documentation. Changes include:
- putting 'openstack baremetal' commands before 'ironic' commands, since
  the plan is to deprecate the 'ironic' CLI
- fixing formatting issues
- removing the description for the 'openstack baremetal create' command
  about how it can be used for creating a node -- this functionality has
  been deleted.
- in the examples, using hardware types instead of classic drivers, since
  the plan is to deprecate classic drivers

Change-Id: I09fdf160122664d923361a8a8c80c61aba347c30

Fix to use "." to source script files

2017-09-01T14:43:08+00:00

Adhering to coding conventions. Refer to ``Code conventions`` at
https://docs.openstack.org/contributor-guide/ for details.

Change-Id: I4637129b2379aa114214e83f8ca1b6786a5e3160

Add auto-generated CLI reference

2017-08-23T20:20:18+00:00

The Ironic OSC plugin CLI was not being fully documented.

This patch enables an auto-generated CLI reference for the OSC plugin.

Note: There is a formatting issue with required arguments that include a
hyphen.  This has been opened as a bug [1].

[1] https://bugs.launchpad.net/python-cliff/+bug/1712612

Closes-Bug: #1712099
Change-Id: I541214f3b3bab9af0ae79c8055dfa1f151560b21

Turn on warning-is-error

2017-07-26T13:40:01+00:00

In the doc-migration, warning-is-error was never enabled
for python-ironicclient. As such, I've enabled it and
corrected the various document errors.

Change-Id: I2d1b95fba25dba5d59da3f4b09b9974ff5196940

Rearrange existing documentation to fit the new standard layout

2017-07-13T19:12:56+00:00

Change-Id: If0c0789ac730c565477b9053d63375c67667b0d1