From e30e77aefa7aa16c5f408e31b9ea7d1db2719ef8 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Mon, 4 May 2015 19:09:19 +0000 Subject: [PATCH] Link to config reference in our docs The ironic configuration options for kilo are documented with the rest of the OpenStack configs at http://docs.openstack.org/kilo/config-reference/content/. This adds a 'Configuration Reference (Kilo)' entry to the index of our developer documentation with a link to the config-reference URL. The install guide also has a link to the config reference. It also removes 'Bare Metal Service' from two entries at http://docs.openstack.org/developer/ironic/, since it seems redundant. (Everything there is about Bare Metal Service!) Change-Id: Idf649641b2108ac6075e7b67c547551bccd9d5f7 --- doc/source/deploy/install-guide.rst | 4 ++-- doc/source/index.rst | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst index 7b1aadad6e..72680aef22 100644 --- a/doc/source/deploy/install-guide.rst +++ b/doc/source/deploy/install-guide.rst @@ -148,8 +148,8 @@ The Bare Metal Service is configured via its configuration file. This file is typically located at ``/etc/ironic/ironic.conf``. Although some configuration options are mentioned here, it is recommended that -you review all the available options so that the Bare Metal Service is -configured for your needs. +you review all the `available options `_ +so that the Bare Metal Service is configured for your needs. #. The Bare Metal Service stores information in a database. This guide uses the MySQL database that is used by other OpenStack services. diff --git a/doc/source/index.rst b/doc/source/index.rst index 7ea533fdb5..2efd216b71 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -56,8 +56,9 @@ Overview :maxdepth: 1 deploy/user-guide - deploy/install-guide - deploy/upgrade-guide + Installation Guide + Upgrade Guide + Configuration Reference (Kilo) deploy/drivers deploy/cleaning