From d38ca3586827466c2e69b7be65164709ce081a52 Mon Sep 17 00:00:00 2001
From: Lucas Alvares Gomes <lucasagomes@gmail.com>
Date: Thu, 18 Feb 2016 10:07:41 +0000
Subject: [PATCH] Add links to the standalone configdrive documentation

Prior to this patch the standalone section of the configuration drive
documentation was talking about a specific format required to the
configuration data but there was no link to the said format, that was
confusing. This patch is adding a link a documentation with an example
of how the data should be organized.

Change-Id: I2fb006c79a20a4795465ce1d992ce8103e6a909b
---
 doc/source/deploy/install-guide.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst
index 8a2a7f65c4..85fa51fdf2 100644
--- a/doc/source/deploy/install-guide.rst
+++ b/doc/source/deploy/install-guide.rst
@@ -2161,7 +2161,7 @@ For the format of the configuration drive, Bare Metal service expects a
 ``gzipped`` and ``base64`` encoded ISO 9660 [*]_ file with a ``config-2``
 label. The
 `ironic client <https://github.com/openstack/python-ironicclient>`_
-can generate a configuration drive in the expected format. Just pass a
+can generate a configuration drive in the `expected format`_. Just pass a
 directory path containing the files that will be injected into it via the
 ``--config-drive`` parameter of the ``node-set-provision-state`` command,
 for example::
@@ -2205,8 +2205,7 @@ especially useful when used with `cloud-init
 <http://cloudinit.readthedocs.org/en/latest/topics/datasources.html#config-drive>`_,
 but in order to use it we should follow some rules:
 
-* ``Cloud-init`` `expects a specific format to the data
-  <http://docs.openstack.org/user-guide/cli_config_drive.html#configuration-drive-contents>`_.
+* ``Cloud-init`` data should be organized in the `expected format`_.
 
 
 * Since the Bare Metal service uses a disk partition as the configuration drive,
@@ -2224,6 +2223,8 @@ but in order to use it we should follow some rules:
   For more information see `how to configure cloud-init data sources
   <http://docs.openstack.org/developer/diskimage-builder/elements/cloud-init-datasources/README.html>`_.
 
+.. _`expected format`: http://docs.openstack.org/user-guide/cli_config_drive.html#openstack-metadata-format
+
 .. _BuildingDeployRamdisk:
 
 Building or downloading a deploy ramdisk image