openstack/ironic
Code Issues Proposed changes

Merge "Fix issues in dev-quickstart and index"

Browse Source
This commit is contained in:
Jenkins 2016-08-24 21:01:25 +00:00 committed by Gerrit Code Review
commit 4ce008e8ff
2 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -196,8 +196,8 @@ Then run ``tox`` with the debug environment as one of the following::
For more information see the `oslotest documentation For more information see the `oslotest documentation
<http://docs.openstack.org/developer/oslotest/features.html#debugging-with-oslo-debug-helper>`_. <http://docs.openstack.org/developer/oslotest/features.html#debugging-with-oslo-debug-helper>`_.
Additional Test Targets Additional Tox Targets
----------------------- ----------------------
There are several additional tox targets not included in the default list, such There are several additional tox targets not included in the default list, such
as the target which builds the documentation site. See the ``tox.ini`` file as the target which builds the documentation site. See the ``tox.ini`` file
@ -243,6 +243,14 @@ Step 1: Create a Python virtualenv
source .tox/venv/bin/activate source .tox/venv/bin/activate
#. Install the ironic client::
pip install python-ironicclient
.. NOTE: You can install python-ironicclient from source by cloning the git
repository and running `pip install .` while in the root of the
cloned repository.
#. Export some ENV vars so the client will connect to the local services #. Export some ENV vars so the client will connect to the local services
that you'll start in the next section:: that you'll start in the next section::
@ -252,8 +260,8 @@ Step 1: Create a Python virtualenv
Next, install and configure system dependencies. Two different approaches are Next, install and configure system dependencies. Two different approaches are
described below; you should only do one of these. described below; you should only do one of these.
Step 2a: System Depdencies In A Virtual Machine Step 2a: System Dependencies In A Virtual Machine
----------------------------------------------- -------------------------------------------------
This option requires `virtualbox <https://www.virtualbox.org>`_, This option requires `virtualbox <https://www.virtualbox.org>`_,
`vagrant <https://www.vagrantup.com>`_, and `vagrant <https://www.vagrantup.com>`_, and

3
doc/source/index.rst
View File

@ -16,7 +16,7 @@ with a unified interface to a heterogeneous fleet of servers while also
providing the Compute service with an interface that allows physical servers to providing the Compute service with an interface that allows physical servers to
be managed as though they were virtual machines. be managed as though they were virtual machines.
`An introduction to the ironic's conceptual architecture <deploy/user-guide>`_ `An introduction to ironic's conceptual architecture <deploy/user-guide>`_
is available for those new to the project. is available for those new to the project.
Site Notes Site Notes
@ -152,6 +152,7 @@ of ironic that may or may not be suitable to every situation.
Adopting Nodes in an ACTIVE state <deploy/adoption> Adopting Nodes in an ACTIVE state <deploy/adoption>
Auditing API Traffic <deploy/api-audit-support> Auditing API Traffic <deploy/api-audit-support>
Configuring for Multi-tenant Networking <deploy/multitenancy> Configuring for Multi-tenant Networking <deploy/multitenancy>
Configuring node web console <deploy/console>
.. TODO:: .. TODO::
Add page on metrics. Add page on metrics.