Skip to content

Commit 442a23b

Browse files
committed
docs(quick-start): add "Get the Source" instructions
1 parent 498562b commit 442a23b

8 files changed

Lines changed: 54 additions & 6 deletions

File tree

docs/_includes/_get-the-source.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Get the Source
2+
--------------
3+
4+
The `source code`_ for Deis must be on your workstation to run the commands in
5+
this documentation. Download an archive file from the `releases page`_, or use
6+
``git`` to clone the repository:
7+
8+
.. code-block:: console
9+
10+
$ git clone https://github.com/deis/deis.git
11+
$ cd deis
12+
13+
If you contribute to Deis or build components locally, use ``go get`` instead to
14+
clone the source code into your `$GOPATH`_:
15+
16+
.. code-block:: console
17+
18+
$ go get -u -v github.com/deis/deis
19+
$ cd $GOPATH/src/github.com/deis/deis
20+
21+
22+
.. _`source code`: https://github.com/deis/deis
23+
.. _`releases page`: https://github.com/deis/deis/releases
24+
.. _`$GOPATH`: http://golang.org/doc/code.html#GOPATH

docs/installing_deis/aws.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Amazon AWS
88

99
In this tutorial, we will show you how to set up your own 3-node cluster on Amazon Web Services.
1010

11-
Please refer to the scripts in `contrib/ec2`_ while following this documentation.
11+
Please :ref:`get the source <get_the_source>` and refer to the scripts in `contrib/ec2`_
12+
while following this documentation.
1213

1314

1415
Install the AWS Command Line Interface

docs/installing_deis/baremetal.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@
66
Bare Metal
77
==========
88

9-
Deis clusters can be provisioned anywhere `CoreOS`_ can, including on your own hardware. To get
10-
CoreOS running on raw hardware, you can boot with `PXE`_ or `iPXE`_ - this will boot a CoreOS
9+
Deis clusters can be provisioned anywhere `CoreOS`_ can, including on your own hardware.
10+
11+
Please :ref:`get the source <get_the_source>` and refer to the scripts in `contrib/bare-metal`_
12+
while following this documentation.
13+
14+
To get CoreOS running on raw hardware, you can boot with `PXE`_ or `iPXE`_ - this will boot a CoreOS
1115
machine running entirely from RAM. Then, you can `install CoreOS to disk`_.
1216

1317
.. important::
@@ -146,6 +150,7 @@ disk. Add the following block to the ``write_files`` section:
146150
options single-request
147151
148152
153+
.. _`contrib/bare-metal`: https://github.com/deis/deis/tree/master/contrib/bare-metal
149154
.. _`cluster size`: https://github.com/coreos/etcd/blob/master/Documentation/optimal-cluster-size.md
150155
.. _`CoreOS`: https://coreos.com/
151156
.. _`install CoreOS to disk`: https://coreos.com/docs/running-coreos/bare-metal/installing-to-disk/

docs/installing_deis/digitalocean.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ DigitalOcean
88

99
In this tutorial, we will show you how to set up your own 3-node cluster on DigitalOcean.
1010

11+
Please :ref:`get the source <get_the_source>` and refer to the scripts in `contrib/digitalocean`_
12+
while following this documentation.
13+
14+
1115
Prerequisites
1216
-------------
1317

@@ -140,6 +144,7 @@ Now that you've finished provisioning a cluster, please refer to :ref:`install_d
140144
start installing the platform.
141145

142146

147+
.. _`contrib/digitalocean`: https://github.com/deis/deis/tree/master/contrib/digitalocean
143148
.. _`docl`: https://github.com/nathansamson/docl#readme
144149
.. _`Deis Control Utility`: https://github.com/deis/deis/tree/master/deisctl#readme
145150
.. _`DNS control panel`: https://cloud.digitalocean.com/domains

docs/installing_deis/gce.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Google Compute Engine
88

99
Let's build a Deis cluster in Google's Compute Engine!
1010

11+
Please :ref:`get the source <get_the_source>` and refer to the scripts in `contrib/gce`_
12+
while following this documentation.
13+
1114

1215
Prerequisites
1316
-------------
@@ -280,6 +283,6 @@ start installing the platform.
280283

281284
It works! Enjoy your Deis cluster in Google Compute Engine!
282285

283-
286+
.. _`contrib/gce`: https://github.com/deis/deis/tree/master/contrib/gce
284287
.. _`Google Cloud SDK`: https://developers.google.com/compute/docs/gcutil/#install
285288
.. _`Google Developer Console`: https://console.developers.google.com/project

docs/installing_deis/quick-start.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ Quick Start
77
These steps will help you provision a Deis cluster.
88

99

10+
.. _get_the_source:
11+
12+
.. include:: ../_includes/_get-the-source.rst
13+
14+
1015
.. _generate_ssh_key:
1116

1217
Generate an SSH key

docs/installing_deis/rackspace.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ Rackspace
77
=========
88

99
We'll mostly be following the `CoreOS on Rackspace`_ guide. You'll need to have a sane python
10-
environment with ``pip`` already installed (``sudo easy_install pip``). Please refer to the scripts
11-
in `contrib/rackspace`_ while following this documentation.
10+
environment with ``pip`` already installed (``sudo easy_install pip``).
11+
12+
Please :ref:`get the source <get_the_source>` and refer to the scripts in `contrib/rackspace`_
13+
while following this documentation.
1214

1315

1416
Install supernova

docs/installing_deis/vagrant.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ Vagrant
99
`Vagrant`_ is a tool for building complete development environments with a focus on automation.
1010
This guide demonstrates how you can stand up a Deis cluster for development purposes using Vagrant.
1111

12+
Please :ref:`get the source <get_the_source>` and refer to the ``Vagrantfile``
13+
while following this documentation.
14+
1215

1316
Install Prerequisites
1417
---------------------

0 commit comments

Comments
 (0)