docs(client): update with dev CLI binaries and local deis.py suggestion

deis · Aug 22, 2014 · b6ccd8b · b6ccd8b
1 parent 21ddb96
commit b6ccd8b
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -95,7 +95,7 @@ If you're using the latest Deis release, use `pip install --upgrade deis` to ins
 If you're working off master, precompiled binaries are likely out of date. You should either symlink the python file directly or build a local copy of the client:
 
 ```console
-$ ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
+$ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
 ```
 or
 ```console

diff --git a/client/README.rst b/client/README.rst
@@ -71,16 +71,25 @@ Get Started
 
 1. `Install the Client`_:
 
+Your Deis client should match your server's version. For development, an
+easy way to ensure this is to run `client/deis.py` in the code repository
+you used to provision the server. You can make a symlink or shell alias for
+`deis` to that file:
+
 .. code-block:: console
 
-    $ sudo pip install deis
+    $ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.3.0
+    $ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
+    $ deis
+    Usage: deis <command> [<args>...]
+
+If you don't have Python_ installed, you can download a binary executable
+version of the Deis client for Mac OS X, Linux amd64, or Windows:
 
-If you don't have `Python`_ installed, you can download a binary executable
-version of the Deis client for Mac OS X, Windows, or Linux amd64:
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-dev.tgz
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-dev.tgz
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-dev.zip
 
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.11.0.tgz
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.11.0.zip
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-0.11.0.tgz
 
 2. `Register a User`_:
 

diff --git a/docs/contributing/localdev.rst b/docs/contributing/localdev.rst
@@ -134,7 +134,7 @@ your local workstation.
 
     $ cd $DEIS_DIR/client
     $ make install
-    $ ln -fs $DEIS_DIR/client/deis.py /usr/local/bin/deis
+    $ sudo ln -fs $DEIS_DIR/client/deis.py /usr/local/bin/deis
     $ deis
     Usage: deis <command> [<args>...]
 

diff --git a/docs/installing_deis/register-admin-user.rst b/docs/installing_deis/register-admin-user.rst
@@ -12,26 +12,25 @@ the client to use Deis.
 
 Install the Deis Client
 -----------------------
-Install the latest Deis client using Python's pip_ package manager:
+Your Deis client should match your server's version. For development, an
+easy way to ensure this is to run `client/deis.py` in the code repository
+you used to provision the server. You can make a symlink or shell alias for
+`deis` to that file:
 
 .. code-block:: console
 
-    $ pip install --upgrade deis
-    Downloading/unpacking deis
-      Downloading deis-0.11.0.tar.gz
-      Running setup.py egg_info for package deis
-      ...
-    Successfully installed deis
-    Cleaning up...
+    $ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.3.0
+    $ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
     $ deis
     Usage: deis <command> [<args>...]
 
 If you don't have Python_ installed, you can download a binary executable
-version of the Deis client for Mac OS X, Windows, or Linux amd64:
+version of the Deis client for Mac OS X, Linux amd64, or Windows:
+
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-dev.tgz
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-dev.tgz
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-dev.zip
 
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.11.0.tgz
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.11.0.zip
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-0.11.0.tgz
 
 Register a User
 ---------------

diff --git a/docs/using_deis/install-client.rst b/docs/using_deis/install-client.rst
@@ -8,33 +8,29 @@ Install the Client
 The Deis command-line interface (CLI), or client, allows you to interact
 with a Deis :ref:`Controller`. You must install the client to use Deis.
 
-Download Binaries
------------------
-You can download a binary executable version of the Deis client for Mac OS X, Windows, or Linux amd64:
-
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.11.0.tgz
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.11.0.zip
-    - https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-0.11.0.tgz
-
-Extract the ``deis`` binary and place it in your workstation path.
-
-Install with Pip
-----------------
-You can also install the latest Deis client using Python's pip_ package manager:
+Install the Deis Client
+-----------------------
+Your Deis client should match your server's version. For development, an
+easy way to ensure this is to run `client/deis.py` in the code repository
+you used to provision the server. You can make a symlink or shell alias for
+`deis` to that file:
 
 .. code-block:: console
 
-    $ sudo pip install --upgrade deis
-    Downloading/unpacking deis
-      Downloading deis-0.11.0.tar.gz
-      Running setup.py egg_info for package deis
-      ...
-    Successfully installed deis
-    Cleaning up...
-
+    $ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.3.0
+    $ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
     $ deis
     Usage: deis <command> [<args>...]
 
+If you don't have Python_ installed, you can download a binary executable
+version of the Deis client for Mac OS X, Linux amd64, or Windows:
+
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-dev.tgz
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-dev.tgz
+    - https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-dev.zip
+
+Extract the ``deis`` binary and place it in your workstation path.
+
 Proxy Support
 -------------
 Set the ```http_proxy``` or ```https_proxy``` environment variable to enable proxy support: