pushing new structure for sphinx nav

liexusong · Aug 2, 2013 · 639e80c · 639e80c
1 parent e0db967
commit 639e80c
Show file tree

Hide file tree

Showing 18 changed files with 173 additions and 99 deletions.
diff --git a/client/deis.py b/client/deis.py
@@ -4,7 +4,7 @@
 
 Usage: deis <command> [--formation <formation>] [<args>...]
 
-::
+Auth commands::
 
   register      register a new user with a controller
   login         login to a controller

diff --git a/docs/commandline/index.rst → docs/client/cheatsheet.rst b/docs/commandline/index.rst → docs/client/cheatsheet.rst
diff --git a/docs/client/converge.rst b/docs/client/converge.rst
@@ -0,0 +1,5 @@
+========
+converge
+========
+
+.. automethod:: client.deis.DeisClient.formations_converge
diff --git a/docs/client/index.rst b/docs/client/index.rst
@@ -0,0 +1,18 @@
+:title: client
+:description: -- todo: change me
+:keywords: deis, documentation, api
+
+.. _client:
+
+CLI Reference
+=============
+
+:Release: |version|
+:Date: |today|
+
+.. toctree::
+    :maxdepth: 1
+
+    cheatsheet
+    login
+    converge
diff --git a/docs/client/login.rst b/docs/client/login.rst
@@ -0,0 +1,5 @@
+=====
+login
+=====
+
+.. automethod:: client.deis.DeisClient.auth_login
diff --git a/docs/contributing/community.rst b/docs/contributing/community.rst
@@ -21,48 +21,8 @@ ends up in the official GitHub repository for Deis. Deis depends on the
 contributions of the community; the maintainers will not ignore pull
 requests or issues.
 
-Conduct
-=======
 
-The deis community welcomes and encourages participation by **everyone**.
-
-No matter how you identify yourself or how others perceive you: we welcome
-you. We welcome contributions from everyone as long as they interact
-constructively with our community.
-
-The deis developer community continues to grow, and it is inevitable that
-disagreements and conflict will arise. We ask that participants conduct
-themselves according to these principles:
-
-- **Be welcoming, friendly, and patient.**
-
-- **Be considerate.**
-
-  Your work will be used by other people, and you in turn will depend on
-  the work of others. Any decision you take will affect users and
-  colleagues, and you should take those consequences into account when
-  making decisions. Remember that we're a world-wide community, so you
-  might not be communicating in someone else's primary language.
-
-- **Be respectful.**
-
-  Not all of us will agree all the time, but disagreement is no excuse
-  for poor behavior and bad manners. We might all experience some
-  frustration now and then, but we cannot allow that frustration to turn
-  into a personal attack. It’s important to remember that a community
-  where people feel uncomfortable or threatened is not a productive one.
-
-- **Be careful in the words that you choose.**
-
-  Be kind to others. Do not insult or put down other participants.
-  Behave professionally. Remember that harassment and sexist, racist, or
-  exclusionary jokes are never appropriate for the community.
-
-(Thanks to the `Debian`_ and `Django`_ communities for their text and
-their inspiration.)
 
 .. _`on Github`: https://github.com/opdemand/deis
 .. _`OpDemand`: http://www.opdemand.com/
-.. _`Debian`: http://www.debian.org/intro/diversity
-.. _`Django`: https://www.djangoproject.com/conduct/
 
diff --git a/docs/contributing/conduct.rst b/docs/contributing/conduct.rst
@@ -0,0 +1,48 @@
+:title: Conduct
+:description: -- todo: change me
+:keywords: deis, documentation, community, bdfl, code, conduct, code of conduct
+
+.. _conduct:
+
+Conduct
+=======
+
+The deis community welcomes and encourages participation by **everyone**.
+
+No matter how you identify yourself or how others perceive you: we welcome
+you. We welcome contributions from everyone as long as they interact
+constructively with our community.
+
+The deis developer community continues to grow, and it is inevitable that
+disagreements and conflict will arise. We ask that participants conduct
+themselves according to these principles:
+
+- **Be welcoming, friendly, and patient.**
+
+- **Be considerate.**
+
+  Your work will be used by other people, and you in turn will depend on
+  the work of others. Any decision you take will affect users and
+  colleagues, and you should take those consequences into account when
+  making decisions. Remember that we're a world-wide community, so you
+  might not be communicating in someone else's primary language.
+
+- **Be respectful.**
+
+  Not all of us will agree all the time, but disagreement is no excuse
+  for poor behavior and bad manners. We might all experience some
+  frustration now and then, but we cannot allow that frustration to turn
+  into a personal attack. It’s important to remember that a community
+  where people feel uncomfortable or threatened is not a productive one.
+
+- **Be careful in the words that you choose.**
+
+  Be kind to others. Do not insult or put down other participants.
+  Behave professionally. Remember that harassment and sexist, racist, or
+  exclusionary jokes are never appropriate for the community.
+
+(Thanks to the `Debian`_ and `Django`_ communities for their text and
+their inspiration.)
+
+.. _`Debian`: http://www.debian.org/intro/diversity
+.. _`Django`: https://www.djangoproject.com/conduct/
diff --git a/docs/contributing/developer.rst → docs/contributing/devsetup.rst b/docs/contributing/developer.rst → docs/contributing/devsetup.rst
@@ -2,14 +2,9 @@
 :description: -- todo: change me
 :keywords: deis, documentation, contributing, developer, setup
 
-.. _developer:
+.. _devsetup:
 
 Developer Setup
 ===============
 
 **Coming soon...**
-
-Coding Standards
-================
-
-**Coming soon...**
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -2,52 +2,18 @@
 :description: TOOD
 :keywords: todo
 
-.. _contributing:
-
 Contributing
 ============
 
-File Bugs & Enhancements
-------------------------
-Find a bug? Want to see a new feature? Have a request
-for the maintainers? Open a `GitHub issue`_ and we’ll get the conversation
-started.
-
-Write Documentation
--------------------
-We are always looking to improve and expand our
-documentation. Most docs reside in the main repository under the `docs/`_
-directory. Simply fork the project, update docs and send us a pull request.
-
-Enhance Chef Integration
-------------------------
-We want Chef users to feel at home using Deis. Got an
-idea for improving our Chef integration? Have some thoughts on making the
-`deis-cookbook`_ more reusable? Open a `GitHub issue`_ and let us know!
-
-Add New Cloud Providers
------------------------
-Want to see Deis extended to a new cloud provider? Go
-for it! Adding new providers is easy. Just follow the `EC2 example`_ and make
-sure you provide test coverage in your pull request.
-
-Improve Deis Core
------------------
-Deis core is a Django/Celery application with a Python CLI.
-We are always looking for help improving the core framework, tooling and test
-coverage. Interested in contributing to Deis core? Let’s chat in IRC.
-
-.. _`Github issue`: https://github.com/opdemand/deis/issues/new
-.. _`docs/`: https://github.com/opdemand/deis/tree/master/docs
-.. _`deis-cookbook`: https://github.com/opdemand/deis-cookbook
-.. _`EC2 Example`: https://github.com/opdemand/deis/blob/master/celerytasks/ec2.py
-
-See Also
---------
+:Release: |version|
+:Date: |today|
 
 .. toctree::
     :maxdepth: 1
 
-    developer
+    overview
+    devsetup
+    standards
     community
+    conduct
 
diff --git a/docs/contributing/overview.rst b/docs/contributing/overview.rst
@@ -0,0 +1,43 @@
+:title: Contributing Overview
+:description: TOOD
+:keywords: todo
+
+.. _contributingoverview:
+
+Overview
+========
+
+File Bugs & Enhancements
+------------------------
+Find a bug? Want to see a new feature? Have a request
+for the maintainers? Open a `GitHub issue`_ and we’ll get the conversation
+started.
+
+Write Documentation
+-------------------
+We are always looking to improve and expand our
+documentation. Most docs reside in the main repository under the `docs/`_
+directory. Simply fork the project, update docs and send us a pull request.
+
+Enhance Chef Integration
+------------------------
+We want Chef users to feel at home using Deis. Got an
+idea for improving our Chef integration? Have some thoughts on making the
+`deis-cookbook`_ more reusable? Open a `GitHub issue`_ and let us know!
+
+Add New Cloud Providers
+-----------------------
+Want to see Deis extended to a new cloud provider? Go
+for it! Adding new providers is easy. Just follow the `EC2 example`_ and make
+sure you provide test coverage in your pull request.
+
+Improve Deis Core
+-----------------
+Deis core is a Django/Celery application with a Python CLI.
+We are always looking for help improving the core framework, tooling and test
+coverage. Interested in contributing to Deis core? Let’s chat in IRC.
+
+.. _`Github issue`: https://github.com/opdemand/deis/issues/new
+.. _`docs/`: https://github.com/opdemand/deis/tree/master/docs
+.. _`deis-cookbook`: https://github.com/opdemand/deis-cookbook
+.. _`EC2 Example`: https://github.com/opdemand/deis/blob/master/celerytasks/ec2.py
diff --git a/docs/contributing/standards.rst b/docs/contributing/standards.rst
@@ -0,0 +1,10 @@
+:title: Coding Standards
+:description: -- todo: change me
+:keywords: deis, documentation, contributing, developer, setup
+
+.. _standards:
+
+Coding Standards
+================
+
+**Coming soon...**
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -9,10 +9,9 @@ FAQ
 
 - What does the word "deis" mean?
 
-    Deis is an alternate spelling for dais_, both of which mean "a raised platform
-    for a speaker or honored guest."
+    Deis is an alternative form of dais_, a raised platform for dignified occupancy.
 
-- How do you prononounce "deis?"
+- How do you pronounce "deis?"
 
     DAY-iss
 

diff --git a/docs/gettingstarted/concepts.rst b/docs/gettingstarted/concepts.rst
@@ -0,0 +1,10 @@
+:title: Concepts
+:description: -- todo: change me
+:keywords: deis, documentation, contributing, developer, setup
+
+.. _concepts:
+
+Concepts
+========
+
+**Coming soon...**
diff --git a/docs/gettingstarted/index.rst b/docs/gettingstarted/index.rst
@@ -0,0 +1,16 @@
+:title: Getting Started
+:description: TOOD
+:keywords: gettingstarted
+
+.. _gettingstarted:
+
+
+Getting Started
+===============
+
+.. toctree::
+    :maxdepth: 1
+
+    concepts
+    tutorial
+    installation
diff --git a/docs/tutorial/installation.rst → docs/gettingstarted/installation.rst b/docs/tutorial/installation.rst → docs/gettingstarted/installation.rst
diff --git a/docs/tutorial/index.rst → docs/gettingstarted/tutorial.rst b/docs/tutorial/index.rst → docs/gettingstarted/tutorial.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,24 +7,23 @@ Welcome
 
 .. image:: _static/img/deis-graphic.png
 
-``deis`` is an open source PaaS that makes it easy to deploy
+Deis is an open source PaaS that makes it easy to deploy
 :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`.
 
-If you are new to ``deis``, start with the :ref:`tutorial`. The :ref:`tutorial`
+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
+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
+If you find a bug, 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
+Developers who want to explore Deis internals should browse the :ref:`api`. 
+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/toctree.rst b/docs/toctree.rst
@@ -11,8 +11,8 @@ This documentation has the following resources:
    :titlesonly:
 
    index
-   tutorial/index
-   commandline/index
+   gettingstarted/index
+   client/index
    api/index
    contributing/index
    releases