Update documentation
authorKostas Papadimitriou <kpap@grnet.gr>
Tue, 8 May 2012 10:56:26 +0000 (13:56 +0300)
committerKostas Papadimitriou <kpap@grnet.gr>
Tue, 8 May 2012 10:56:26 +0000 (13:56 +0300)
docs/source/index.rst

index 86ec165..27f78a3 100644 (file)
@@ -14,17 +14,12 @@ snf-cloudcms is a cms application based on `django`_ and `feincms`_.
 The project created to power websites that provide information about the
 `cloud services`_ deployed by `GRNET`_. 
 
-Currentrly the application provides the following features:
+At the current state the application provides the following features:
 
 * basic cms funcionality (adding/removing/editing hierarchical pages)
 * blog application
-
-in the near future the following additional features will get included 
-within the application:
-
-* Service resources management (presentations, technical papaer, white papers
-  etc.)
-* Service support (faq, userguide, service tickets etc.)
+* FAQ application
+* Resources application (for presentations, technical papers etc.)
 
 .. _django: http://www.djangoproject.com
 .. _feincms: http://feinheit.ch/media/labs/feincms/
@@ -40,8 +35,8 @@ Using debian packages
 
 Although not required it is recommended to use `snf-webproject`_ to deploy the
 cms application. If you want to deploy using your custom django project take
-a look on `cloudcms/synnefo_settings.py`_ file which includes `snf-webproject`
-hooks to find which django settings are required for cms to work.
+a look on ``cloudcms/synnefo_settings.py`` where `snf-webproject` hooks are
+defined to find which django settings are required for cms to work.
 
 .. _snf-webproject: http://docs.dev.grnet.gr/snf-webproject
 
@@ -117,7 +112,7 @@ editing the content of your cms.
 
 
 Static files
-************
+------------
 
 snf-cloudcms requires the following static files to be served by your django
 project:
@@ -142,7 +137,7 @@ urls which can be altered in your settings files:
 
 
 CMS uploads
-***********
+-----------
 
 snf-cloudcms uses feincms medialibrary application to store and display
 files in cms pages. The location of those files is based on MEDIA_ROOT setting
@@ -161,6 +156,61 @@ permissions::
     chmod o+rw /usr/share/synnefo/sattic/medialibrary
 
 
+Admin guide
+===========
+
+Bind blog to a cms page
+-----------------------
+
+1. Create a page on the cms tree.
+2. On the region you want the blog content to appear (list of posts, and post
+   details), add an ``Application content`` content type and choose ``Cloud
+   blog`` from the drop down list.
+3. On navigation extension settings of the page, choose ``blog categories``.
+
+Bind FAQs to a cms page
+------------------------
+
+1. Create a page on the cms tree.
+2. On the region you want the blog content to appear (list of posts, and post
+   details), add an ``Application content`` content type and choose ``Cloud
+   FAQ`` from the drop down list.
+3. *Optional:* On navigation extension settings of the page, choose 
+   ``faq categories``.
+
+Bind resources to a cms page
+----------------------------
+
+1. Create a page on the cms tree.
+2. On the region you want the resources to appear append a ``Resources list``
+   content type.
+
+
+FAQ's guide
+-----------
+
+Adding a question
+^^^^^^^^^^^^^^^^^
+
+1. Open the faq's list in admin panel (``/cmsmanage/cloudcmsfaq/question/``)
+   and press the ``Add faq`` button.
+2. Fill in the required fields:
+    * Title, the question.
+    * Author, the question author.
+    * Slug, the url to be used for the current question
+      (should get autocompleted after filling the title field)
+    * Category, the category of the question.
+
+3. On the main content area tab add the content you want to be displayed as the
+   answer of the question.
+    * ``Rich text`` (can be added by pressing the icon with the pencil) and 
+      ``Raw content`` may contain html text.
+
+4. Click save.
+
+
+.. include:: ../../Changelog
+
 Indices and tables
 ==================