.. Aurinko documentation master file, created by
   sphinx-quickstart on Fri Jul 11 13:56:10 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Aurinko's documentation!
===================================

Contents:

.. toctree::
    pages/index
    address
    data-model
    :maxdepth: 1

Terms
-----

* **Aurinko**: Frontend Implementation

* **Aurinko Corona**: Backend web interface. Help Moderators moderating messages. See section Aurinko Corona for details.

    * *Moderator*: User with access to Aurinko Corona.

* **Aurinko Data**: Tool to auto-import from various data sources (show as “Import” in image).

    * *Data Provider*: Company which sends batch updates for listings, like Telekom, Yext, etc.

* **Persistent Storage**: Database which allows long term storage of data (currently MongoDB)

* **Aurinko Solr**: Jobs server which reads from the Queues and updates the Solr cluster.

    * *Moderation Queue (MODQ)*: a Queue, which helds all entry data in need of review by the moderation team.

    * *Publish Queue (PUBQ)*: a Queue which holds all entry data ready to be published or deleted from the website.



Architecture overview
---------------------

.. image:: _static/overview.png