Skip to content

Commit 66f4b3d

Browse files
mboersmaMatthew Fisher
authored andcommitted
docs(scheduler): updated CLI instructions and developer docs
1 parent 4c99c2b commit 66f4b3d

5 files changed

Lines changed: 42 additions & 26 deletions

File tree

docs/developer/buildpack.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:title: Deploying with Heroku Buildpacks on Deis
2-
:description: A howto on deploying applications using Heroku Buildpacks
2+
:description: How to deploy applications using Heroku Buildpacks
33

44
Buildpacks
55
==========
@@ -52,10 +52,6 @@ push. For example:
5252
=== classy-hardtack
5353
BUILDPACK_URL: https://github.com/bacongobbler/heroku-buildpack-jekyll
5454
55-
.. note::
56-
57-
Setting config variables before your first deployment results in an error. See `issue
58-
542`_ for more details.
5955
6056
.. _`Java buildpack`: https://github.com/heroku/heroku-buildpack-java.git
6157
.. _`Ruby buildpack`: https://github.com/heroku/heroku-buildpack-ruby.git
@@ -70,4 +66,3 @@ push. For example:
7066
.. _`Perl buildpack`: https://github.com/miyagawa/heroku-buildpack-perl/tree/carton
7167
.. _`builder recipe`: https://github.com/opdemand/deis-cookbook/blob/master/recipes/builder.rb
7268
.. _`Deis cookbook`: https://github.com/opdemand/deis-cookbook.git
73-
.. _`issue 542`: https://github.com/opdemand/deis/issues/542

docs/developer/deploy-application.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before deploying an application, all users must first authenticate against the D
1616

1717
.. code-block:: console
1818
19-
$ deis login http://example.com
19+
$ deis login http://example.com:8000
2020
username: deis
2121
password:
2222
Logged in as deis
@@ -30,7 +30,7 @@ create`` command to create a remote repository for you to push your application
3030
.. code-block:: console
3131
3232
$ cd example-java-jetty # change into your application's git root
33-
$ deis create --formation=dev
33+
$ deis create --cluster=dev
3434
Creating application... done, created peachy-waxworks
3535
Git remote deis added
3636
@@ -43,7 +43,7 @@ you can use `our Dockerfile example`_.
4343

4444
.. code-block:: console
4545
46-
><> deis create --formation=dev
46+
><> deis create --cluster=dev
4747
Creating application... done, created owlish-huntress
4848
Git remote deis added
4949
><> git push deis master

docs/developer/install-client.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33

44
Install the Client
55
==================
6-
The Deis client allows you to interact with a Deis :ref:`Controller`.
7-
You'll need to install the client before you can use Deis.
6+
The Deis command-line interface (CLI), or client, allows you to interact
7+
with a Deis :ref:`Controller`. You must install the client to use Deis.
88

99
Install with Pip
1010
----------------
11-
Install the latest Deis client using Python's `pip`_:
11+
Install the latest Deis client using Python's pip_ package manager:
1212

1313
.. code-block:: console
1414
@@ -22,6 +22,14 @@ Install the latest Deis client using Python's `pip`_:
2222
$ deis
2323
Usage: deis <command> [<args>...]
2424
25+
If you don't have Python_ installed, you can download a binary executable
26+
version of the Deis client for Mac OS X, Windows, or Debian Linux:
27+
28+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.8.0.tgz
29+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.8.0.zip
30+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-deb-wheezy-0.8.0.tgz
31+
32+
2533
Integrated Help
2634
---------------
2735
The Deis client comes with comprehensive documentation for every command.
@@ -60,4 +68,7 @@ To get help on subcommands, use ``deis help [subcommand]``:
6068
6169
Use `deis help [command]` to learn more
6270
63-
.. _`pip`: http://www.pip-installer.org/en/latest/installing.html
71+
.. _pip: http://www.pip-installer.org/en/latest/installing.html
72+
.. _Python: https://www.python.org/
73+
74+

docs/gettingstarted/usage.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
:title: Usage
2-
:description: Use the Deis Command-line interface to create a formation for your app, push your code, and scale your own cloud resources.
2+
:description: The command-line interface (CLI) is how you interact with Deis.
33

44
.. _usage:
55

66
Usage
77
=====
8-
9-
Once you have set up a Deis Controller (see the :ref:`Operations Guide <operations>`), you
10-
will use the Deis CLI (command-line interface) to create a formation for
11-
your app, push your code, and scale your own cloud resources.
8+
Once you have provisioned a Deis Controller
9+
(see the :ref:`Operations Guide <operations>`), use the
10+
command-line interface (CLI) to create a cluster for your app, to push
11+
your code, and to scale your cloud resources.
1212

1313
.. automodule:: client.deis
14-
:no-members:
15-
:no-undoc-members:
14+
:no-members:
15+
:no-undoc-members:

docs/operations/register-admin-user.rst

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55

66
Register an Admin User
77
======================
8-
Once your :ref:`Controller` is running you need to register an admin user
9-
using the Deis command-line client.
8+
Once your :ref:`Controller` is running, you must register an admin user.
9+
using the Deis client. The Deis command-line interface (CLI), or client,
10+
allows you to interact with a Deis :ref:`Controller`. You must install
11+
the client to use Deis.
1012

11-
Install the Deis Client
12-
-----------------------
13-
Install the latest Deis client using Python's `pip`_:
13+
Install with Pip
14+
----------------
15+
Install the latest Deis client using Python's pip_ package manager:
1416

1517
.. code-block:: console
1618
@@ -24,6 +26,13 @@ Install the latest Deis client using Python's `pip`_:
2426
$ deis
2527
Usage: deis <command> [<args>...]
2628
29+
If you don't have Python_ installed, you can download a binary executable
30+
version of the Deis client for Mac OS X, Windows, or Debian Linux:
31+
32+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.8.0.tgz
33+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.8.0.zip
34+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-deb-wheezy-0.8.0.tgz
35+
2736
Register a User
2837
---------------
2938
Now that the client is installed, create a user account on the Deis :ref:`Controller`.
@@ -51,5 +60,6 @@ Now that the client is installed, create a user account on the Deis :ref:`Contro
5160
:code:`deis register http://deis.example.com:8000`
5261

5362

54-
.. _`pip`: http://www.pip-installer.org/en/latest/installing.html
63+
.. _pip: http://www.pip-installer.org/en/latest/installing.html
64+
.. _Python: https://www.python.org/
5565
.. _`issue 535`: https://github.com/opdemand/deis/issues/535

0 commit comments

Comments
 (0)