Merge pull request #2532 from mboersma/docs-install-inlines

Move "generate SSH key" and "make discovery-url" sections inline to docs

Author: mboersma

docs/_includes/_generate-discovery-url.rst

@@ -0,0 +1,13 @@
+A discovery URL links `etcd`_ instances together by storing their peer
+addresses and metadata under a unique identifier. Run this command from the root
+of the repository to generate a ``contrib/coreos/user-data`` file with a new
+discovery URL:
+
+.. code-block:: console
+
+    $ make discovery-url
+
+Required scripts are supplied in this ``user-data`` file, so do not provision a
+Deis cluster without running ``make discovery-url``.
+
+.. _`etcd`: https://github.com/coreos/etcd

docs/_includes/_generate-ssh-key.rst

@@ -0,0 +1,7 @@
+The ``deisctl`` utility communicates with remote machines over an SSH tunnel.
+If you don't already have an SSH key, the following command will generate
+a new keypair named "deis":
+
+.. code-block:: console
+
+    $ ssh-keygen -q -t rsa -f ~/.ssh/deis -N '' -C deis

docs/_includes/_get-the-source.rst

@@ -1,6 +1,3 @@
-Get the Source
---------------
-
 The `source code`_ for Deis must be on your workstation to run the commands in
 this documentation. Download an archive file from the `releases page`_, or use
 ``git`` to clone the repository:

docs/installing_deis/aws.rst

@@ -71,17 +71,7 @@ Deis clusters of less than 3 nodes are unsupported.
 Generate a New Discovery URL
 ----------------------------
 
-To get started with provisioning Deis, we will need to generate a new Discovery URL. Discovery URLs
-help connect `etcd`_ instances together by storing a list of peer addresses and metadata under a
-unique address. You can generate a new discovery URL for use in your platform by
-running the following from the root of the repository:
-
-.. code-block:: console
-
-    $ make discovery-url
-
-This will write a new discovery URL to the user-data file. Some convenience scripts are supplied in
-this user-data file, so it is mandatory for provisioning Deis.
+.. include:: ../_includes/_generate-discovery-url.rst
 
 
 Customize cloudformation.json

docs/installing_deis/baremetal.rst

@@ -25,10 +25,11 @@ Check System Requirements
 Please refer to :ref:`system-requirements` for resource considerations when choosing a
 machine size to run Deis.
 
+
 Generate SSH Key
 ----------------
 
-Please refer to :ref:`generate_ssh_key` for generating a new SSH key.
+.. include:: ../_includes/_generate-ssh-key.rst
 
 
 Customize user-data
@@ -38,7 +39,7 @@ Customize user-data
 Generate a New Discovery URL
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
+.. include:: ../_includes/_generate-discovery-url.rst
 
 
 SSH Key

docs/installing_deis/digitalocean.rst

@@ -31,15 +31,18 @@ Check System Requirements
 Please refer to :ref:`system-requirements` for resource considerations when choosing a droplet
 size to run Deis.
 
+
 Generate SSH Key
 ----------------
 
-Please refer to :ref:`generate_ssh_key` for generating a new SSH key.
+.. include:: ../_includes/_generate-ssh-key.rst
+
 
 Generate a New Discovery URL
 ----------------------------
 
-Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
+.. include:: ../_includes/_generate-discovery-url.rst
+
 
 Create CoreOS Droplets
 ----------------------

docs/installing_deis/quick-start.rst

@@ -9,38 +9,27 @@ These steps will help you provision a Deis cluster.
 
 .. _get_the_source:
 
+Get the Source
+--------------
+
 .. include:: ../_includes/_get-the-source.rst
 
 
 .. _generate_ssh_key:
 
-Generate an SSH key
--------------------
-
-The ``deisctl`` utility communicates with remote machines over an SSH tunnel.
-If you don't already have an SSH key, the following command will generate
-a new keypair named "deis":
-
-.. code-block:: console
+Generate SSH Key
+----------------
 
-    $ ssh-keygen -q -t rsa -f ~/.ssh/deis -N '' -C deis
+.. include:: ../_includes/_generate-ssh-key.rst
 
 
 .. _generate_discovery_url:
 
 Generate a New Discovery URL
 ----------------------------
 
-Discovery URLs help connect `etcd`_ instances together by storing a list of peer addresses and metadata under a
-unique address. You can generate a new discovery URL for use in your platform by
-running the following from the root of the repository:
-
-.. code-block:: console
-
-    $ make discovery-url
+.. include:: ../_includes/_generate-discovery-url.rst
 
-This will write a new discovery URL to the user-data file. Some essential scripts are supplied in
-this user-data file, so it is mandatory for provisioning Deis.
 
 Check System Requirements
 -------------------------
@@ -76,4 +65,3 @@ please refer to :ref:`install_deisctl` and :ref:`install_deis_platform`.
 
 
 .. _`CoreOS`: https://coreos.com/
-.. _`etcd`: https://github.com/coreos/etcd

docs/installing_deis/rackspace.rst

@@ -45,7 +45,7 @@ API key can be found on the Account Settings page.
 Generate SSH Key
 ----------------
 
-Please refer to :ref:`generate_ssh_key` for generating a new SSH key.
+.. include:: ../_includes/_generate-ssh-key.rst
 
 
 Set up your keys
@@ -61,7 +61,7 @@ Tell supernova about the key pair and give it an identifiable name:
 Generate a New Discovery URL
 ----------------------------
 
-Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
+.. include:: ../_includes/_generate-discovery-url.rst
 
 
 Choose number of instances

docs/installing_deis/vagrant.rst

@@ -28,13 +28,13 @@ Please install `Vagrant`_ v1.6.5+ and `VirtualBox`_.
 Generate SSH Key
 ----------------
 
-Please refer to :ref:`generate_ssh_key` for generating a new SSH key.
+.. include:: ../_includes/_generate-ssh-key.rst
 
 
 Generate a New Discovery URL
 ----------------------------
 
-Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
+.. include:: ../_includes/_generate-discovery-url.rst
 
 
 Boot CoreOS