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 @@ + + Development options + + + 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::