Added sphinx :ref: tags to docs.

mboersma · mboersma · commit b4d32dc61023 · 2013-07-26T19:45:54.000-06:00
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -2,5 +2,16 @@
 :description: -- todo: change me
 :keywords: deis, documentation, tutorial, contributing, faq
 
+.. _api:
+
 API
 ===
+
+.. automodule:: api.fields
+  :members:
+
+.. automodule:: api.models
+  :members:
+
+.. automodule:: api.routers
+  :members:
diff --git a/docs/commandline/index.rst b/docs/commandline/index.rst
@@ -1,6 +1,8 @@
-:title: Deis command line cheat sheet
+:title: CLI cheatsheet
 :description: TODO
 :keywords: todo
 
-Command line cheat sheet
-========================
+.. _cheatsheet:
+
+CLI cheatsheet
+==============
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -1,6 +1,8 @@
-:title: Contributing to Deis
+:title: Contributing
 :description: TOOD
 :keywords: todo
 
-Contributing to Deis
-====================
+.. _contributing:
+
+Contributing
+============
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -1,6 +1,8 @@
-:title: Deis FAQ
+:title: FAQ
 :description: Frequently Asked Questions about the Deis PaaS solution
 :keywords: deis, PaaS, cloud, faq
 
+.. _faq:
+
 FAQ
 ===
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,22 +1,31 @@
 :title: Welcome to the Deis documentation
 :description: An overview of the Deis documentation
-:keywords: deis, cloud, heroku
+:keywords: api, commandline, command-line, contributing, faq, terms, tutorial, deis, docker, heroku
 
-Welcome
-=======
+Documentation
+=============
 
 .. image:: https://s3-us-west-2.amazonaws.com/deis-images/deis-graphic.png
 
-What is Deis?
--------------
 
 ``deis`` is an open source PaaS that makes it easy to deploy
-:ref:`container_def`\s and  :ref:`node_def`\s used to host applications,
+:ref:`container`\s and  :ref:`node`\s used to host applications,
 databases, middleware and other services. Deis leverages Chef, Docker and
 Heroku Buildpacks to provide a private PaaS that is lightweight and flexible.
+For more about ``deis``, check our :ref:`faq`.
 
-Deis comes with out-of-the-box support for Ruby, Python, Node.js, Java,
-Clojure, Scala, Play, PHP, Perl, Dart and Go. However, Deis can deploy
-*anything* using Heroku Buildpacks, Docker images, or Chef recipes. Deis is
-designed to work with any cloud provider, although only EC2 is currently
-supported.
+If you are new to ``deis``, start with the :ref:`tutorial`. The :ref:`tutorial`
+also references the :ref:`installation` guide.
+
+Once you have set up a ``deis controller``, you will use the
+``deis`` **command-line client** to create an app, push your code, and
+scale your own cloud resources. ``deis --help`` is very helpful, but we
+also have a :ref:`cheatsheet` with examples of usage.
+
+If you find a bug in ``deis``, please report it to the project at
+https://github.com/opdemand/deis/issues
+
+Developers who want to use ``deis`` should browse the :ref:`api`. Then
+fork the open source deis repository and enjoy the freedom of your own
+private PaaS. The ``deis`` project won't ignore pull requests; please help
+us improve.
diff --git a/docs/terms/container.rst b/docs/terms/container.rst
@@ -1,23 +1,8 @@
 :title: Container
 :description: What is a Deis Container?
-:keywords: deis, container
+:keywords: lxc container, lxc, container, deis, docker
 
-.. _container_def:
+.. _container:
 
-Container
-=========
-
-You think water moves fast? You should see ice. It moves like it has a mind.
-Like it knows it killed the world once and got a taste for murder. After the
-avalanche, it took us a week to climb out. Now, I don't know exactly when we
-turned on each other, but I know that seven of us survived the slide... and
-only five made it out. Now we took an oath, that I'm breaking now. We said
-we'd say it was the snow that killed the other two, but it wasn't. Nature is
-lethal but it doesn't hold a candle to man.
-
-Your bones don't break, mine do. That's clear. Your cells react to bacteria
-and viruses differently than mine. You don't get sick, I do. That's also
-clear. But for some reason, you and I react the exact same way to water. We
-swallow it too fast, we choke. We get some in our lungs, we drown. However
-unreal it may seem, we are connected, you and I. We're on the same curve, just
-on opposite ends.
+LXC Container
+=============
diff --git a/docs/terms/node.rst b/docs/terms/node.rst
@@ -1,21 +1,8 @@
 :title: Chef Node
 :description: What is a Chef Node in Deis?
-:keywords: deis, chef, node
+:keywords: chef node, chef, node, deis
 
-.. _node_def:
+.. _node:
 
 Chef Node
 =========
-
-Do you see any Teletubbies in here? Do you see a slender plastic tag clipped
-to my shirt with my name printed on it? Do you see a little Asian child with a
-blank expression on his face sitting outside on a mechanical helicopter that
-shakes when you put quarters in it? No? Well, that's what you see at a toy
-store. And you must think you're in a toy store, because you're here shopping
-for an infant named Jeb.
-
-Now that we know who you are, I know who I am. I'm not a mistake! It all makes
-sense! In a comic, you know how you can tell who the arch-villain's going to
-be? He's the exact opposite of the hero. And most times they're friends, like
-you and me! I should've known way back when... You know why, David? Because of
-the kids. They called me Mr Glass.
diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst
@@ -2,5 +2,7 @@
 :description: TODO
 :keywords: todo
 
+.. _tutorial:
+
 Tutorial
 ========
diff --git a/docs/tutorial/installation.rst b/docs/tutorial/installation.rst
@@ -0,0 +1,8 @@
+:title: Installation
+:description: TODO
+:keywords: todo
+
+.. _installation:
+
+Installation
+============
