Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

refactoring doc contents.

  • Loading branch information...
commit 80db8022c60cf03931e1ceefba8c4f3eecdd89f3 1 parent aae0c31
Yohei Sasaki authored
View
47 doc/source/app.rst
@@ -1,47 +0,0 @@
-Application Development
---------------------------------------------------------------------------------
-
-.. warning:: This chapter is *underconstruction*
-
-This chapter shows you a tutorial for the development of a simple sunrise application.
-
-Create your application development environment
-================================================================================
-
-``sunrise:app`` command (TBD)
-
-Develop CouchApp
-================================================================================
-
-${APP_ROOT}/
-
-Sunrise App is a CouchApp application.
-
-Develop a node handler (Optional)
-================================================================================
-
-``${APP_ROOT}/node/handler.js``
-
-
-implement a routing.
-
-Develop a node model (Optional)
-================================================================================
-
-``${APP_ROOT}/node/model.js``
-
-implement a server side javascript logic which is difficult on CouchApp.
-
-
-Develop a node view plugin (Optional)
-================================================================================
-
-``${APP_ROOT}/node/helper.js``
-
-
-View Resolution
-================================================================================
-
-``${APP_ROOT}/_attachments/templates/``
-
-Important to design a scope of one view file for overwriting.x
View
2  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']
View
41 doc/source/deployment.rst
@@ -1,41 +0,0 @@
-Deployment Tips
---------------------------------------------------------------------------------
-
-Configuration File
-================================================================================
-
-Sunrise default configuration file is packaged on the `sunrise itself <https://github.com/yssk22/sunrise/tree/master/lib/sunrise/default/conf>`_ .
-
-This file is overwritten by -c option on booting.
-
-For example:
-
-::
-
- $ ls ../conf
- web.json
-
- $ cat ../conf/web.json
- {
- "port": 8080
- }
-
- $ node boot.js -c ../conf
-
-In this boot operation, the sunrise server uses 8080 port instead of 8888. Other configuration options such as listen IP address are still by default.
-
-Use forever
-================================================================================
-
-You can boot sunrise server with ``forever``, which avoids unexpected server crashes.
-
-::
-
- $ npm install forever
- $ forever start boot.js -c ../conf
-
-Application Logging
-================================================================================
-
-TBD
-
View
47 doc/source/development.rst
@@ -1,47 +0,0 @@
-Application Development
---------------------------------------------------------------------------------
-
-.. warning:: This chapter is *underconstruction*
-
-This chapter shows you a tutorial for the development of a simple sunrise application.
-
-Create your application development environment
-================================================================================
-
-``sunrise:app`` command (TBD)
-
-Develop CouchApp
-================================================================================
-
-${APP_ROOT}/
-
-Sunrise App is a CouchApp application.
-
-Develop a node handler (Optional)
-================================================================================
-
-``${APP_ROOT}/node/handler.js``
-
-
-implement a routing.
-
-Develop a node model (Optional)
-================================================================================
-
-``${APP_ROOT}/node/model.js``
-
-implement a server side javascript logic which is difficult on CouchApp.
-
-
-Develop a node view plugin (Optional)
-================================================================================
-
-``${APP_ROOT}/node/helper.js``
-
-
-View Resolution
-================================================================================
-
-``${APP_ROOT}/_attachments/templates/``
-
-Important to design a scope of one view file for overwriting.x
View
2  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
View
1  doc/source/index.rst
@@ -16,6 +16,7 @@ Application Development Guide
getting_started
architecture
+ tutorial/index
tips/index
ref/index
View
4 doc/source/site.rst
@@ -1,4 +0,0 @@
-Customize your site
---------------------------------------------------------------------------------
-
-.. warning:: This chapter is *underconstruction*
View
14 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
+
View
44 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.
+
+::
+
+

0 comments on commit 80db802

Please sign in to comment.
Something went wrong with that request. Please try again.