From 07d30f85de3c3847d468f4820c244056635e907f Mon Sep 17 00:00:00 2001 From: Sergio Oliveira Date: Mon, 13 Apr 2015 12:03:31 -0300 Subject: [PATCH] Improved docs home page --- docs/source/index.rst | 37 ++++++++++++++++++++++++------------- docs/source/plugindev.rst | 5 ++++- docs/source/static/colab-basics.jpg | Bin 0 -> 46713 bytes 3 files changed, 28 insertions(+), 14 deletions(-) create mode 100644 docs/source/static/colab-basics.jpg diff --git a/docs/source/index.rst b/docs/source/index.rst index a95f72b..77267ea 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,24 +3,35 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to colab's documentation! -================================= +Colab - Integration Server for Web Applications +=============================================== -Colab is a framework meant to help integration of web applications in three -different ways: +Colab is an integration server meant to help develpers to unify the **User Experience** in Web applications. -* Authentication -* Visual -* Data +Colab provides ways to integrate: -Colab also comes with the following features: +* Authentication or Single Sign-On (SSO) +* User Interface (UI) +* Data -* Mailman native integration -* Webchat (XMPP) -* Planet (feed aggregation) -* Code paste -* Login with Persona +To accomplish that Colab is placed in front of integrated Web applications. All user requests and responses are proxied (as in the image :ref:`image-reverse-proxy`) and therefore can have content and headers modified. Also, due to it's architecture, Colab can grant or deny access to systems under it. +.. _image-reverse-proxy: + +.. figure:: static/colab-basics.jpg + :width: 400 px + :align: center + + *Colab Reverse Proxy model* + +Plugins are used in order to integrate new Web applications. Currently the following plugins are available and maintained by core developers: + +* Mailman +* Gitlab +* Trac +* Jenkins + +If you need to integrate a diffirent tool please refer to :ref:`plugin-dev`. Contents: diff --git a/docs/source/plugindev.rst b/docs/source/plugindev.rst index 2f6eb0d..1a26e12 100644 --- a/docs/source/plugindev.rst +++ b/docs/source/plugindev.rst @@ -1,5 +1,8 @@ + +.. _plugin-dev: + Plugin Developer Documentation -================== +==================================== Getting Started --------------- diff --git a/docs/source/static/colab-basics.jpg b/docs/source/static/colab-basics.jpg new file mode 100644 index 0000000..b460e09 Binary files /dev/null and b/docs/source/static/colab-basics.jpg differ -- libgit2 0.21.2