Skip to content

Commit a6a3082

Browse files
author
Matthew Fisher
committed
docs(reference): update reference guide
1 parent 5615af7 commit a6a3082

20 files changed

Lines changed: 52 additions & 113 deletions

‎docs/reference/client/apps.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
:title: Applications
22
:description: Learn how to manage Deis applications using the Deis client, including how to create, list, open, retrieve logs for, run ephemeral commands on, and destroy applications.
33

4+
.. _deis_apps:
5+
46
apps
57
====
68

‎docs/reference/client/auth.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:title: Auth
2+
:description: Learn how to authenticate with a Deis controller using the Deis client.
3+
4+
.. _deis_auth:
5+
6+
auth
7+
====
8+
9+
.. automethod:: client.deis.DeisClient.auth_register
10+
.. automethod:: client.deis.DeisClient.auth_cancel
11+
.. automethod:: client.deis.DeisClient.auth_login
12+
.. automethod:: client.deis.DeisClient.auth_logout

‎docs/reference/client/builds.rst‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
:title: Releases
2-
:description: Learn how to releases of an application using the Deis client.
1+
:title: Builds
2+
:description: Learn how to manage builds of an application using the Deis client.
33

4-
release
5-
=======
4+
.. _deis_builds:
65

7-
.. automethod:: client.deis.DeisClient.releases_list
8-
.. automethod:: client.deis.DeisClient.releases_info
6+
builds
7+
======
8+
9+
.. automethod:: client.deis.DeisClient.builds_list
10+
.. automethod:: client.deis.DeisClient.builds_create

‎docs/reference/client/clusters.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
:title: Clusters
22
:description: Learn how to manage Deis clusters using the Deis client, including how to create, list, update and destroy clusters.
33

4+
.. _deis_clusters:
5+
46
clusters
57
========
68

‎docs/reference/client/config.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
:title: Config
22
:description: Learn how to list, set and unset environment variables for an application using the Deis client.
33

4+
.. _deis_config:
5+
46
config
57
======
68

‎docs/reference/client/create.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎docs/reference/client/destroy.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎docs/reference/client/domains.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:title: Domains
2+
:description: Learn how to bind domain names to an application using the Deis client.
3+
4+
.. _deis_domains:
5+
6+
domains
7+
=======
8+
9+
.. automethod:: client.deis.DeisClient.domains_add
10+
.. automethod:: client.deis.DeisClient.domains_list
11+
.. automethod:: client.deis.DeisClient.domains_remove

‎docs/reference/client/index.rst‎

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,14 @@ Client Reference
1212
.. toctree::
1313

1414

15-
register
16-
login
17-
logout
18-
19-
create
20-
scale
21-
info
22-
open
23-
logs
24-
run
25-
destroy
26-
27-
clusters
28-
keys
15+
auth
2916

3017
apps
18+
clusters
3119
ps
3220
config
21+
domains
3322
builds
3423
releases
24+
25+
keys

‎docs/reference/client/info.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)