Skip to content

Commit 887d30a

Browse files
committed
docs(*): refactor and reorganize
Reorganize the docs to make more sense for users.
1 parent df1c0ed commit 887d30a

92 files changed

Lines changed: 1441 additions & 126 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Trying out Deis? Continue following these instructions for a local cluster setup
1515

1616
# Upgrading Deis
1717

18-
Upgrading from a previous Deis release? See [Upgrading Deis](http://docs.deis.io/en/latest/operations/upgrading-deis/) for additional information.
18+
Upgrading from a previous Deis release? See [Upgrading Deis](http://docs.deis.io/en/latest/installing_deis/upgrading-deis/) for additional information.
1919

2020
## Install prerequisites
2121
On your workstation:
@@ -72,7 +72,7 @@ Use `make run` to start all Deis containers and attach to their log output. This
7272
$ make run
7373
```
7474

75-
Your Vagrant VM is accessible at `local.deisapp.com` (or `local3.deisapp.com`/`local5.deisapp.com`). For clusters on other platforms (EC2, Rackspace, bare metal, etc.), see our guide to [Configuring DNS](http://docs.deis.io/en/latest/operations/configure-dns/).
75+
Your Vagrant VM is accessible at `local.deisapp.com` (or `local3.deisapp.com`/`local5.deisapp.com`). For clusters on other platforms (EC2, Rackspace, bare metal, etc.), see our guide to [Configuring DNS](http://docs.deis.io/en/latest/installing_deis/configure-dns/).
7676

7777
## Testing the cluster
7878
Integration tests and corresponding documentation can be found under the `test/` folder.

client/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,11 @@ version of the Deis client for Mac OS X, Windows, or Debian Linux:
129129
130130
To learn more, use ``deis help`` or browse `the documentation`_.
131131

132-
.. _`Install the Client`: http://docs.deis.io/en/latest/developer/install-client/
132+
.. _`Install the Client`: http://docs.deis.io/en/latest/using_deis/install-client/
133133
.. _`Python`: http://www.python.org/
134-
.. _`Register a User`: http://docs.deis.io/en/latest/developer/register-user/
135-
.. _`Deploy an Application`: http://docs.deis.io/en/latest/developer/deploy-application/
136-
.. _`Manage an Application`: http://docs.deis.io/en/latest/developer/manage-application/
134+
.. _`Register a User`: http://docs.deis.io/en/latest/using_deis/register-user/
135+
.. _`Deploy an Application`: http://docs.deis.io/en/latest/using_deis/deploy-application/
136+
.. _`Manage an Application`: http://docs.deis.io/en/latest/using_deis/manage-application/
137137
.. _`the documentation`: http://docs.deis.io/
138138

139139

contrib/ec2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The script will deploy Deis and make sure the services start properly.
8484

8585
## Configure DNS
8686
While you can reference the controller and hosted applications with public hostnames provided by EC2, it is recommended for ease-of-use that
87-
you configure your own DNS records using a domain you own. See [Configuring DNS](http://docs.deis.io/en/latest/operations/configure-dns/) for details.
87+
you configure your own DNS records using a domain you own. See [Configuring DNS](http://docs.deis.io/en/latest/installing_deis/configure-dns/) for details.
8888

8989
## Use Deis!
9090
After that, register with Deis!

contrib/rackspace/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ $ cd ../.. && make run
7070
The script will deploy Deis and make sure the services start properly.
7171

7272
### Configure DNS
73-
You'll need to configure DNS records so you can access applications hosted on Deis. See [Configuring DNS](http://docs.deis.io/en/latest/operations/configure-dns/) for details.
73+
You'll need to configure DNS records so you can access applications hosted on Deis. See [Configuring DNS](http://docs.deis.io/en/latest/installing_deis/configure-dns/) for details.
7474

7575
### Use Deis!
7676
After that, register with Deis!

controller/web/static/css/main.css

Lines changed: 702 additions & 1 deletion
Large diffs are not rendered by default.

controller/web/static/js/checkURL.js

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,31 @@
22
$('.toctree-l1 > a:contains("Releases")').siblings().remove();
33

44
//Check URL
5-
var path = window.location.href;
6-
var pathName = path.split('/');
7-
var num = pathName.length - 3;
5+
var path = window.location.pathname.split('/');
6+
var cleanedPath = $.grep(path,function(n){ return(n) });
87

9-
switch(pathName[num]) {
10-
case 'gettingstarted':
11-
$('.toctree-l1 > a:contains("Getting Started")').attr('state', 'open');
8+
// the second to last path segment is the section
9+
switch(cleanedPath[cleanedPath.length-2]) {
10+
case 'understanding_deis':
11+
$('.toctree-l1 > a:contains("Understanding Deis")').attr('state', 'open');
1212
break;
13-
case 'installation':
14-
$('.toctree-l1 > a:contains("Installation")').attr('state', 'open');
13+
case 'installing_deis':
14+
$('.toctree-l1 > a:contains("Installing Deis")').attr('state', 'open');
1515
break;
16-
case 'operations':
17-
$('.toctree-l1 > a:contains("Operations")').attr('state', 'open');
16+
case 'using_deis':
17+
$('.toctree-l1 > a:contains("Using Deis")').attr('state', 'open');
1818
break;
19-
case 'developer':
20-
$('.toctree-l1 > a:contains("Developer")').attr('state', 'open');
21-
break;
22-
case 'components':
23-
$('.toctree-l1 > a:contains("Components")').attr('state', 'open');
24-
break;
25-
case 'topologies':
26-
$('.toctree-l1 > a:contains("Topologies")').attr('state', 'open');
19+
case 'managing_deis':
20+
$('.toctree-l1 > a:contains("Managing Deis")').attr('state', 'open');
2721
break;
2822
case 'contributing':
2923
$('.toctree-l1 > a:contains("Contributing")').attr('state', 'open');
3024
break;
25+
case 'reference':
3126
case 'client':
32-
$('.toctree-l1 > a:contains("Client Reference")').attr('state', 'open');
33-
break;
3427
case 'server':
35-
$('.toctree-l1 > a:contains("Server Reference")').attr('state', 'open');
28+
case 'terms':
29+
$('.toctree-l1 > a:contains("Reference Guide")').attr('state', 'open');
3630
break;
3731
default:
3832
$('.toctree-l1 > a:contains("Version")').attr('state', 'close');

docs/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ dirhtml:
3131
@echo
3232
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
3333

34+
auto: dirhtml
35+
sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
36+
3437
help:
3538
@echo "Please use \`make <target>' where <target> is one of"
3639
@echo " html to make standalone HTML files"

docs/contributing/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Contributing
88
:Date: |today|
99

1010
.. toctree::
11-
:maxdepth: 1
11+
1212

1313
overview
1414
localdev

docs/contributing/localdev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ access using:
153153
154154
155155
Your local development environment is running! Follow the
156-
rest of the :ref:`Developer Guide <developer>` to deploy your first application.
156+
rest of the `_using_deis` guide to deploy your first application.
157157

158158
Test Your Changes
159159
-----------------

docs/index.rst

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,13 @@
33

44
Welcome
55
=======
6-
Deis is a lightweight, flexible and powerful open source PaaS. Building
7-
on Docker and CoreOS, Deis provides a familiar, Heroku-inspired workflow
8-
using efficient containerization, on your cloud or hardware.
9-
Your PaaS. Your Rules.
6+
Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage applications
7+
on your own servers. Deis builds upon Docker and CoreOS to provide a lightweight PaaS with a
8+
Heroku-inspired workflow.
109

11-
.. image:: ../controller/web/static/img/deis-graphic.png
12-
:alt: Deis cover logo
13-
14-
If you are new to Deis, start with :ref:`Concepts` and basic
15-
:ref:`Usage` of the command-line client. Follow the
16-
:ref:`Developer Guide <developer>` to learn how to deploy and scale
17-
your own application. The :ref:`Operations Guide <operations>` will
18-
walk you through provisioning and managing Deis itself.
10+
To get started with Deis, first read :ref:`Understanding Deis <understanding_deis>`.
1911

20-
So how does it work? Read about the overall :ref:`architecture` and
21-
individual :ref:`components`, or search the API reference for the
22-
:ref:`Client <client>` and :ref:`Server <server>`.
12+
The full documentation tree can be seen `here </toctree/>`_.
2313

24-
Interested in contributing to the Deis project? Check out our
25-
:ref:`Local Development <localdev>` instructions
26-
and :ref:`Contributor Overview <contributor>`.
14+
.. image:: ../controller/web/static/img/deis-graphic.png
15+
:alt: Deis cover logo

0 commit comments

Comments
 (0)