Commit 20e18a91c427971acd306e0268e41c1b78d6350a
1 parent
546cdff2
Exists in
master
and in
39 other branches
Basic structure documentation
BROWSERID documentation Signed-off-by: Alexandre Barbosa <alexandreab@live.com> Signed-off-by: Carlos Oliveira <carlospecter@gmail.com> Signed-off-by: Sergio Oliveira <sergio@tracy.com.br>
Showing
4 changed files
with
107 additions
and
0 deletions
Show diff stats
docs/source/index.rst
| @@ -6,11 +6,30 @@ | @@ -6,11 +6,30 @@ | ||
| 6 | Welcome to colab's documentation! | 6 | Welcome to colab's documentation! |
| 7 | ================================= | 7 | ================================= |
| 8 | 8 | ||
| 9 | +Colab is a framework meant to help integration of web applications in three | ||
| 10 | +different ways: | ||
| 11 | + | ||
| 12 | +* Authentication | ||
| 13 | +* Visual | ||
| 14 | +* Data | ||
| 15 | + | ||
| 16 | +Colab also comes with the following features: | ||
| 17 | + | ||
| 18 | +* Mailman native integration | ||
| 19 | +* Webchat (XMPP) | ||
| 20 | +* Planet (feed aggregation) | ||
| 21 | +* Code paste | ||
| 22 | +* Login with Persona | ||
| 23 | + | ||
| 24 | + | ||
| 9 | Contents: | 25 | Contents: |
| 10 | 26 | ||
| 11 | .. toctree:: | 27 | .. toctree:: |
| 12 | :maxdepth: 2 | 28 | :maxdepth: 2 |
| 13 | 29 | ||
| 30 | + user | ||
| 31 | + plugindev | ||
| 32 | + dev | ||
| 14 | 33 | ||
| 15 | 34 | ||
| 16 | Indices and tables | 35 | Indices and tables |
| @@ -0,0 +1,76 @@ | @@ -0,0 +1,76 @@ | ||
| 1 | +User Documentation | ||
| 2 | +================== | ||
| 3 | + | ||
| 4 | +Getting Started | ||
| 5 | +--------------- | ||
| 6 | + | ||
| 7 | +Dependencies | ||
| 8 | +++++++++++++ | ||
| 9 | +.. TODO | ||
| 10 | + | ||
| 11 | +Install | ||
| 12 | ++++++++ | ||
| 13 | +.. TODO | ||
| 14 | + | ||
| 15 | +Plugins | ||
| 16 | +------- | ||
| 17 | +.. TODO | ||
| 18 | + | ||
| 19 | +Settings | ||
| 20 | +-------- | ||
| 21 | + | ||
| 22 | +Blog Planet | ||
| 23 | ++++++++++++ | ||
| 24 | +.. TODO | ||
| 25 | + | ||
| 26 | +Paste | ||
| 27 | ++++++ | ||
| 28 | +.. TODO | ||
| 29 | + | ||
| 30 | +XMPP | ||
| 31 | +++++ | ||
| 32 | +.. TODO | ||
| 33 | + | ||
| 34 | +SVN | ||
| 35 | ++++ | ||
| 36 | +.. TODO | ||
| 37 | + | ||
| 38 | +Auth | ||
| 39 | +++++ | ||
| 40 | +.. attribute:: BROWSERID_ENABLED | ||
| 41 | + | ||
| 42 | + :default: False | ||
| 43 | + | ||
| 44 | + When this variable is True, Colab use BrowserID authentication. By default, | ||
| 45 | + django authentication system is used. | ||
| 46 | + | ||
| 47 | +.. attribute:: BROWSERID_AUDIENCES | ||
| 48 | + | ||
| 49 | + :default: No default | ||
| 50 | + | ||
| 51 | + List of audiences that your site accepts. An audience is the protocol, | ||
| 52 | + domain name, and (optionally) port that users access your site from. This | ||
| 53 | + list is used to determine the audience a user is part of (how they are | ||
| 54 | + accessing your site), which is used during verification to ensure that the | ||
| 55 | + assertion given to you by the user was intended for your site. | ||
| 56 | + | ||
| 57 | + Without this, other sites that the user has authenticated with via Persona | ||
| 58 | + could use their assertions to impersonate the user on your site. | ||
| 59 | + | ||
| 60 | + Note that this does not have to be a publicly accessible URL, so local URLs | ||
| 61 | + like ``http://localhost:8000`` or ``http://127.0.0.1`` are acceptable as | ||
| 62 | + long as they match what you are using to access your site. | ||
| 63 | + | ||
| 64 | +Customization | ||
| 65 | +------------- | ||
| 66 | +Home Page | ||
| 67 | ++++++++++ | ||
| 68 | +.. TODO | ||
| 69 | + | ||
| 70 | +Menu | ||
| 71 | +++++ | ||
| 72 | +.. TODO | ||
| 73 | + | ||
| 74 | +Templates | ||
| 75 | ++++++++++ | ||
| 76 | +.. TODO |