From 500c14a965ba9a99f4c06ed579fd9049e6a6e48c Mon Sep 17 00:00:00 2001
From: James Slagle <jslagle@redhat.com>
Date: Tue, 22 Sep 2015 15:57:48 -0400
Subject: [PATCH] Add source admonition

Using puppet modules from source is no longer required. However, it's
still useful to document how to do so for those that want to. This
creates a new source admonition that can be used to document such
things.

Change-Id: I5393bbfca51ebe97065995123a3d59a8719aaa81
---
 doc/source/_custom/custom.css                        | 1 +
 doc/source/_templates/layout.html                    | 8 ++++++++
 doc/source/basic_deployment/basic_deployment_cli.rst | 9 ++++++---
 doc/source/index.rst                                 | 6 ++++++
 doc/source/installation/installing.rst               | 9 ++++++---
 5 files changed, 27 insertions(+), 6 deletions(-)

diff --git a/doc/source/_custom/custom.css b/doc/source/_custom/custom.css
index 6967b100..0869bd36 100644
--- a/doc/source/_custom/custom.css
+++ b/doc/source/_custom/custom.css
@@ -65,6 +65,7 @@
 .baremetal {background: #eef;}
 .virtual {background: #efe;}
 .ceph {background: #eff;}
+.source {background: #bbb;}
 
 /* admonition selector */
 #admonition_selector {
diff --git a/doc/source/_templates/layout.html b/doc/source/_templates/layout.html
index e27dcd66..94e6e0c1 100644
--- a/doc/source/_templates/layout.html
+++ b/doc/source/_templates/layout.html
@@ -36,6 +36,14 @@
       <ul>
         <li><input type="checkbox" id="ceph" checked="checked"><label for="ceph" title="Step that should only be run when deploying Ceph for use by the Overcloud.">Ceph</label></li>
       </ul>
+
+      <span class="title">Development options</span>
+      <ul>
+        <li><input type="checkbox" id="source" checked=""><label for="source"
+            title="Step that should only be run when choosing to use some components directly from their git source code repositories instead of packages.">Installing from source/git</label></li>
+      </ul>
+
+
     </div>
   </div>
 
diff --git a/doc/source/basic_deployment/basic_deployment_cli.rst b/doc/source/basic_deployment/basic_deployment_cli.rst
index 2cfbe869..266b1cf5 100644
--- a/doc/source/basic_deployment/basic_deployment_cli.rst
+++ b/doc/source/basic_deployment/basic_deployment_cli.rst
@@ -134,10 +134,13 @@ non-root user that was used to install the undercloud.
 
       export DELOREAN_TRUNK_MGT_REPO="http://trunk.rdoproject.org/centos7/current/"
 
-  For the moment, git checkouts of the puppet modules must be used. Export the
-  following environment variable::
+  .. admonition:: Source
+     :class: source
 
-    export DIB_INSTALLTYPE_puppet_modules=source
+     Git checkouts of the puppet modules can be used instead of packages. Export the
+     following environment variable::
+
+       export DIB_INSTALLTYPE_puppet_modules=source
 
   ::
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
index fadf19d2..0bf967dc 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -61,5 +61,11 @@ steps are marked as follows:
 
    Step that should only be run when deploying Ceph for use by the Overcloud
 
+.. admonition:: Source
+   :class: source
+
+   Step that should only be run when choosing to use some components directly
+   from their git source code repositories instead of packages.
+
 Any such steps should *not* be run if the target environment does not match
 the section marking.
diff --git a/doc/source/installation/installing.rst b/doc/source/installation/installing.rst
index 52fe5688..cf67f180 100644
--- a/doc/source/installation/installing.rst
+++ b/doc/source/installation/installing.rst
@@ -71,10 +71,13 @@ Installing the Undercloud
 
         cp /usr/share/instack-undercloud/undercloud.conf.sample ~/undercloud.conf
 
-  For the moment, git checkouts of the puppet modules must be used. Export the
-  following environment variable::
+  .. admonition:: Source
+     :class: source
 
-    export DIB_INSTALLTYPE_puppet_modules=source
+     Git checkouts of the puppet modules can be used instead of packages. Export the
+     following environment variable::
+
+       export DIB_INSTALLTYPE_puppet_modules=source
 
   Install the undercloud::