diff options
| author | Dmitry Tantsur <divius.inside@gmail.com> | 2018-08-14 13:06:21 +0200 |
|---|---|---|
| committer | Dmitry Tantsur <divius.inside@gmail.com> | 2018-09-27 13:47:54 +0200 |
| commit | c4ddb327a11e645e3e0a2686863fac4cca954db6 (patch) | |
| tree | b51a44e6d47d991f8f78c59eeb1126e13a84d3ae | |
| parent | 8dcbf5b6d0bc2c2dc3881dbc557e2e403e2fe2b4 (diff) | |
| download | python-ironicclient-c4ddb327a11e645e3e0a2686863fac4cca954db6.tar.gz | |
Minor fixes to README.rst
* Correct the title of README.rst (currently it's titled "Team
and repository tags", which is obviously not the project name).
* Move useful links to the top, so that they're easier to find
(especially the link to the full documentation).
* Link to api-ref instead of rarely updated wiki page when
referring to the bare metal API.
Change-Id: Ibd62c7bfc5ff77a16690cfa98f7164906a49abad
| -rw-r--r-- | README.rst | 33 |
1 files changed, 17 insertions, 16 deletions
@@ -1,17 +1,18 @@ -======================== +================================== +Python bindings for the Ironic API +================================== + Team and repository tags -======================== +------------------------ .. image:: https://governance.openstack.org/tc/badges/python-ironicclient.svg :target: https://governance.openstack.org/tc/reference/tags/index.html -.. Change things from this point on - -Python bindings for the Ironic API -================================== +Overview +-------- -This is a client for the OpenStack `Ironic -<https://wiki.openstack.org/wiki/Ironic>`_ API. It provides: +This is a client for the OpenStack `Bare Metal API +<https://developer.openstack.org/api-ref/baremetal/>`_. It provides: * a Python API: the ``ironicclient`` module, and * two command-line interfaces: ``openstack baremetal`` and ``ironic`` @@ -28,6 +29,14 @@ like the rest of OpenStack. .. contents:: Contents: :local: +Useful Links +------------ + +* Documentation: https://docs.openstack.org/python-ironicclient/latest/ +* Source: https://git.openstack.org/cgit/openstack/python-ironicclient +* Bugs: https://storyboard.openstack.org/#!/project/959 +* Release notes: https://docs.openstack.org/releasenotes/python-ironicclient/ + Python API ---------- @@ -118,11 +127,3 @@ For more information about the ``ironic`` command and the subcommands available, run:: $ ironic help - -Useful Links ------------- - -* Documentation: https://docs.openstack.org/python-ironicclient/latest/ -* Source: https://git.openstack.org/cgit/openstack/python-ironicclient -* Bugs: https://storyboard.openstack.org/#!/project/959 -* Release notes: https://docs.openstack.org/releasenotes/python-ironicclient/ |