From 459dfa27066a3218b6cc401747f0d6ef8e575013 Mon Sep 17 00:00:00 2001 From: Jay Faulkner Date: Wed, 24 Aug 2016 09:27:17 -0700 Subject: [PATCH] Fix issues in dev-quickstart and index Fixes issues pointed out post merge in doc update: - s/Test/Tox/ in the header for dev-quickstart - Adding instructions for installing python-ironicclient - Fixed grammar issue in index.rst - Readded link to console documentation Change-Id: If10e4dd1aaf608442022c7e544f5a6ffaa923a9a --- doc/source/dev/dev-quickstart.rst | 16 ++++++++++++---- doc/source/index.rst | 3 ++- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/doc/source/dev/dev-quickstart.rst b/doc/source/dev/dev-quickstart.rst index 814e1df2c3..edcff22677 100644 --- a/doc/source/dev/dev-quickstart.rst +++ b/doc/source/dev/dev-quickstart.rst @@ -196,8 +196,8 @@ Then run ``tox`` with the debug environment as one of the following:: For more information see the `oslotest documentation `_. -Additional Test Targets ------------------------ +Additional Tox Targets +---------------------- 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 @@ -243,6 +243,14 @@ Step 1: Create a Python virtualenv 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 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 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 `_, `vagrant `_, and diff --git a/doc/source/index.rst b/doc/source/index.rst index 002d6a3864..f6d09d54df 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 be managed as though they were virtual machines. -`An introduction to the ironic's conceptual architecture `_ +`An introduction to ironic's conceptual architecture `_ is available for those new to the project. Site Notes @@ -151,6 +151,7 @@ of ironic that may or may not be suitable to every situation. Adopting Nodes in an ACTIVE state Auditing API Traffic Configuring for Multi-tenant Networking + Configuring node web console .. TODO:: Add page on metrics.