Commit 07d30f85de3c3847d468f4820c244056635e907f
1 parent
09148eef
Exists in
master
and in
33 other branches
Improved docs home page
Showing
3 changed files
with
28 additions
and
14 deletions
Show diff stats
docs/source/index.rst
| @@ -3,24 +3,35 @@ | @@ -3,24 +3,35 @@ | ||
| 3 | You can adapt this file completely to your liking, but it should at least | 3 | You can adapt this file completely to your liking, but it should at least |
| 4 | contain the root `toctree` directive. | 4 | contain the root `toctree` directive. |
| 5 | 5 | ||
| 6 | -Welcome to colab's documentation! | ||
| 7 | -================================= | 6 | +Colab - Integration Server for Web Applications |
| 7 | +=============================================== | ||
| 8 | 8 | ||
| 9 | -Colab is a framework meant to help integration of web applications in three | ||
| 10 | -different ways: | 9 | +Colab is an integration server meant to help develpers to unify the **User Experience** in Web applications. |
| 11 | 10 | ||
| 12 | -* Authentication | ||
| 13 | -* Visual | ||
| 14 | -* Data | 11 | +Colab provides ways to integrate: |
| 15 | 12 | ||
| 16 | -Colab also comes with the following features: | 13 | +* Authentication or Single Sign-On (SSO) |
| 14 | +* User Interface (UI) | ||
| 15 | +* Data | ||
| 17 | 16 | ||
| 18 | -* Mailman native integration | ||
| 19 | -* Webchat (XMPP) | ||
| 20 | -* Planet (feed aggregation) | ||
| 21 | -* Code paste | ||
| 22 | -* Login with Persona | 17 | +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. |
| 23 | 18 | ||
| 19 | +.. _image-reverse-proxy: | ||
| 20 | + | ||
| 21 | +.. figure:: static/colab-basics.jpg | ||
| 22 | + :width: 400 px | ||
| 23 | + :align: center | ||
| 24 | + | ||
| 25 | + *Colab Reverse Proxy model* | ||
| 26 | + | ||
| 27 | +Plugins are used in order to integrate new Web applications. Currently the following plugins are available and maintained by core developers: | ||
| 28 | + | ||
| 29 | +* Mailman | ||
| 30 | +* Gitlab | ||
| 31 | +* Trac | ||
| 32 | +* Jenkins | ||
| 33 | + | ||
| 34 | +If you need to integrate a diffirent tool please refer to :ref:`plugin-dev`. | ||
| 24 | 35 | ||
| 25 | Contents: | 36 | Contents: |
| 26 | 37 |
docs/source/plugindev.rst
45.6 KB