refactoring doc contents.

yssk22 · May 22, 2011 · 80db802 · 80db802
1 parent aae0c31
commit 80db802
Show file tree

Hide file tree

Showing 9 changed files with 61 additions and 141 deletions.
diff --git a/doc/source/app.rst b/doc/source/app.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -25,7 +25,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinxtogithub', 'sphinx.ext.todo', 'sphinx.ext.pngmath']
+extensions = ['sphinx.ext.todo', 'sphinx.ext.pngmath']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst
diff --git a/doc/source/development.rst b/doc/source/development.rst
diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
@@ -67,7 +67,7 @@ Configure settings
 
 ``${YOUR_SITE_DIR}/conf`` contains default configurations. You can configure settings such as OAuth provides, CouchDB admin account, Cookie settings, ... and so on.
 
-Configuration details are described at :doc:`ref/conf`_
+Configuration details are described at :doc:`ref/conf`.
 
 
 Configure bootstrap

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -16,6 +16,7 @@ Application Development Guide
 
    getting_started
    architecture 
+   tutorial/index
    tips/index
    ref/index
 

diff --git a/doc/source/site.rst b/doc/source/site.rst
diff --git a/doc/source/tutorial/index.rst b/doc/source/tutorial/index.rst
@@ -0,0 +1,14 @@
+Application Development Tutorial
+-----------------------------------
+
+This capter shows you how to develop your application running on sunrise step by step.
+
+.. toctree::
+   :maxdepth: 2
+
+   introduction
+   helloworld
+   db_access
+   design_doc
+   helper
+
diff --git a/doc/source/tutorial/introduction.rst b/doc/source/tutorial/introduction.rst
@@ -0,0 +1,44 @@
+Introduction
+--------------------------------------------------------------------------------
+
+What is an application?
+================================================================================
+
+An **application** in Sunrise is:
+
+- A design document for CouchDB
+
+  - a static file collection attached on the design document. 
+
+- A middleware for Express/Connect
+
+And an application is installed on a specified path in the site. It provides http based services and it can also provides helper functions for other applications.
+
+
+Overview of application development
+================================================================================
+
+1. Create a template site (for application testing)
+2. Create your application from the template
+3. Modify scripts
+4. Test with installing on the site.
+5. Publish your application.
+
+This chapter shows brief introduction for these steps.
+
+
+Create a template site.
+-------------------------------------------------------------------------------
+
+At first, you need to a container site for your application to be installed for testing. As described at :doc:`../getting_started`, use ``sunrise:create`` command.
+
+::
+
+   $ sunrise\:create -s sunrise-site
+
+
+Then your site directory is as follows.
+
+::
+
+