Synnefo » snf-cloudcms

v0.11.0

-------

* Userguide application

* FAQ's application

* Client downloads application

* New service models

* New html/css theme

* Responsive html content

* Userguide/FAQ's import from rst tool

* Django auth context processor as snf-webproject hook

* Major database updates. Use::

	$ snf-manage syncdb

	$ snf-image migrate

  to update existing databases. Additionally you can initiate service models and

  media categories for FAQ/Userguide applications by loading the provided

  fixtures::

	$ snf-manage loaddata cloudcms_media_categories

	$ snf-manage loaddata cloudcms_default_services

* Basic cms funcionality (adding/removing/editing hierarchical pages)

* Blog application

* User guide application

.. note::

    Synnefo components and additional required packages can be obtained from 

    ``apt.dev.grnet.gr`` debian repository. To enable the repository add the 

    following lines in ``/etc/apt/sources.list.d/apt.dev.grnet.list``::

        deb http://apt.dev.grnet.gr squeeze main 

        deb-src http://apt.dev.grnet.gr squeeze main

Bind blog application to a cms page

-----------------------------------

1. Create a page on the cms tree using the ``Blog template`` template. 

Bind FAQs application to a cms page

-----------------------------------

1. Create a page on the cms tree using the ``FAQ's template`` template.

2. On the top region add an ``Application content`` content type and choose 

   ``Cloud FAQ`` from the drop down list.

Bind resources application to a cms page

----------------------------------------

Bind Userguide application to a cms page

-----------------------------------------

1. Create a page on the cms tree using the ``Userguide template`` template.

2. On the top region add an ``Application content`` content type and choose 

   ``Cloud user guide`` from the drop down list.

Importing FAQ's and Userguide entries from rst files

----------------------------------------------------

Cloudcms provides a way to import content for faq and userguide applications

from rst files. This allows you to keep the guide and faq content tracked in

rst markup format seperately from the cms database (e.g. in a git repository 

maintained by your documentation team), and update the cms content on demand.

.. warning::

    Notice that you can still edit the FAQ's and Userguide entries using the 

    corresponding section in the cms admin interface, but beware that mixing both

    methods is not recommended since it's ineffective and prone to data loss.

To access the import form, login to the admin site and open the following url::

    https://cms.com/cmsmange/rstimport/

The required file should be a zip archive containing files of the following 

structure (similar to common sphinx project structure)::

        ├── README.rst

        └── source

            ├── conf.py

            ├── faq

            │   ├── cyclades.rst

            │   ├── index.rst

            │   ├── okeanos.rst

            │   └── pithos.rst

            ├── images

            │   ├── cyclades

            │   │   ├── image10.png

            │   │   └── image9.png

            │   ├── faq

            │   │   └── faq_image1.png

            │   ├── intro_img_cyclades.png

            │   └── pithos_guide

            │       └── image2.png

            ├── index.rst

            └── userguide

                ├── cyclades.rst

                ├── index.rst

                ├── pithos.rst

                └── quick-intro.rst

.. warning::

    Notice that directory names ``faq``, ``userguide`` are mandatory.

By submiting the form the application will act as follows

- Clean existing data if ``clean data`` was checked. This includes **all** 

  FAQ/Userguide entries, FAQ categories and media files linked to them.

- Will search for files named after the ``CMS_RST_IMPORT_SERVICE_FILE_MAP``

  setting both in ``faq`` and ``userguide`` directories, to identify which

  service the contents of the file are referred to. The default setting value 

  is (maps files to service slugs)::

        DEFAULT_SERVICE_MAP = {

                'cyclades': 'cyclades',

                'okeanos': 'okeanos',

                'pithos': 'pithos'

        }

- For the FAQ entries which are structured by service/category, the importer will

  parse secondary headings as FAQ categories and tertiary headings as FAQ

  entries.

- For the Userguide entries which only require the service to be linked to, the

  secondary headings and their content are parsed as Userguide entries

- For both FAQ and Userguide entries the linked images will be uploaded

  in the media files application and the html anchors will get updated

  containing a valid cms link.

.. warning::

    Import helper uses python ``docutils`` to parse .rst files contents. This

    means that additional sphinx directives like ``:ref:`` or ``.. code-block``

    won't be parsed as excpected. This behaviour might get improved in future

    versions. Until then try to compromise your content to `basic rst format`_.

.. _basic rst format: http://docutils.sourceforge.net/docs/user/rst/quickstart.html