openstack/ironic
Code Issues Proposed changes

Fix typos in Ironic docs

Browse Source 
Change-Id: I96dac53f9a23b24716313c88205ad0cbe6bbb9c8
This commit is contained in:
Mitsuhiro SHIGEMATSU 2015-05-11 16:40:58 +09:00
parent 3ddc26ef0c
commit acdec5b592
4 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/deploy/install-guide.rst
View File

@ -890,8 +890,8 @@ controller in your bare metal server by using ``ipmitool``::
*Note:* *Note:*
#. This is not the bare metal server’s main IP. The IPMI controller #. This is not the bare metal server's main IP. The IPMI controller
should have it’s own unique IP. should have it's own unique IP.
#. In case the above command doesn't return the power status of the #. In case the above command doesn't return the power status of the
bare metal server, check for these: bare metal server, check for these:

2
doc/source/deploy/upgrade-guide.rst
View File

@ -27,7 +27,7 @@ your Nova and Ironic services are as follows:
- Install new python-ironicclient code. - Install new python-ironicclient code.
- Restart Nova services. - Restart Nova services.
- Install new Ironic code, run database migrations, restart Ironic services. - Install new Ironic code, run database migrations, restart Ironic services.
- Edit nova.conf and set force_config_drive to your liking, restaring - Edit nova.conf and set force_config_drive to your liking, restarting
nova-compute if necessary. nova-compute if necessary.
Note that during the period between Nova's upgrade and Ironic's upgrades, Note that during the period between Nova's upgrade and Ironic's upgrades,

4
doc/source/dev/dev-quickstart.rst
View File

@ -22,8 +22,8 @@ Install prerequisites:
sudo yum install python-devel openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel git git-review libffi-devel gettext ipmitool psmisc graphviz sudo yum install python-devel openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel git git-review libffi-devel gettext ipmitool psmisc graphviz
If using RHEL and yum reports “No package python-pip available” and “No If using RHEL and yum reports "No package python-pip available" and "No
package git-review available”, use the EPEL software repository. package git-review available", use the EPEL software repository.
Instructions can be found at `<http://fedoraproject.org/wiki/EPEL/FAQ#howtouse>`_. Instructions can be found at `<http://fedoraproject.org/wiki/EPEL/FAQ#howtouse>`_.
- openSUSE/SLE 12:: - openSUSE/SLE 12::

16
doc/source/dev/drivers.rst
View File

@ -57,12 +57,12 @@ While performing the request, a lock is held on the node, and other
requests for the node will be delayed and may fail with an HTTP 409 requests for the node will be delayed and may fail with an HTTP 409
(Conflict) error code. (Conflict) error code.
This endpoint exposes a node’s driver directly, and as such, it is This endpoint exposes a node's driver directly, and as such, it is
expressly not part of Ironic’s standard REST API. There is only a expressly not part of Ironic's standard REST API. There is only a
single HTTP endpoint exposed, and the semantics of the message body single HTTP endpoint exposed, and the semantics of the message body
are determined solely by the driver. Ironic makes no guarantees about are determined solely by the driver. Ironic makes no guarantees about
backwards compatibility; this is solely up to the discretion of each backwards compatibility; this is solely up to the discretion of each
driver’s author. driver's author.
To get information about all the methods available via the vendor_passthru To get information about all the methods available via the vendor_passthru
endpoint for a particular node, you can issue an HTTP GET request:: endpoint for a particular node, you can issue an HTTP GET request::
@ -70,8 +70,8 @@ endpoint for a particular node, you can issue an HTTP GET request::
GET /v1/nodes/<Node UUID or name>/vendor_passthru/methods GET /v1/nodes/<Node UUID or name>/vendor_passthru/methods
The response's JSON body will contain information for each method, The response's JSON body will contain information for each method,
such as the method’s name, a description, the HTTP methods supported, such as the method's name, a description, the HTTP methods supported,
and whether it’s asynchronous or synchronous. and whether it's asynchronous or synchronous.
Driver Vendor Passthru Driver Vendor Passthru
@ -100,7 +100,7 @@ A method:
HTTP 409 (Conflict) error code. HTTP 409 (Conflict) error code.
Ironic makes no guarantees about the semantics of the message BODY sent Ironic makes no guarantees about the semantics of the message BODY sent
to this endpoint. That is left up to each driver’s author. to this endpoint. That is left up to each driver's author.
To get information about all the methods available via the driver To get information about all the methods available via the driver
vendor_passthru endpoint, you can issue an HTTP GET request:: vendor_passthru endpoint, you can issue an HTTP GET request::
@ -108,5 +108,5 @@ vendor_passthru endpoint, you can issue an HTTP GET request::
GET /v1/drivers/<driver name>/vendor_passthru/methods GET /v1/drivers/<driver name>/vendor_passthru/methods
The response's JSON body will contain information for each method, The response's JSON body will contain information for each method,
such as the method’s name, a description, the HTTP methods supported, such as the method's name, a description, the HTTP methods supported,
and whether it’s asynchronous or synchronous. and whether it's asynchronous or synchronous.