diff --git a/docs/source/dev.rst b/docs/source/dev.rst new file mode 100644 index 0000000..51bfcc7 --- /dev/null +++ b/docs/source/dev.rst @@ -0,0 +1,6 @@ +Developer Documentation +================== + +Getting Started +--------------- +.. TODO diff --git a/docs/source/index.rst b/docs/source/index.rst index f65858d..a95f72b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,11 +6,30 @@ Welcome to colab's documentation! ================================= +Colab is a framework meant to help integration of web applications in three +different ways: + +* Authentication +* Visual +* Data + +Colab also comes with the following features: + +* Mailman native integration +* Webchat (XMPP) +* Planet (feed aggregation) +* Code paste +* Login with Persona + + Contents: .. toctree:: :maxdepth: 2 + user + plugindev + dev Indices and tables diff --git a/docs/source/plugindev.rst b/docs/source/plugindev.rst new file mode 100644 index 0000000..2f6eb0d --- /dev/null +++ b/docs/source/plugindev.rst @@ -0,0 +1,6 @@ +Plugin Developer Documentation +================== + +Getting Started +--------------- +.. TODO diff --git a/docs/source/user.rst b/docs/source/user.rst new file mode 100644 index 0000000..f585cd0 --- /dev/null +++ b/docs/source/user.rst @@ -0,0 +1,76 @@ +User Documentation +================== + +Getting Started +--------------- + +Dependencies +++++++++++++ +.. TODO + +Install ++++++++ +.. TODO + +Plugins +------- +.. TODO + +Settings +-------- + +Blog Planet ++++++++++++ +.. TODO + +Paste ++++++ +.. TODO + +XMPP +++++ +.. TODO + +SVN ++++ +.. TODO + +Auth +++++ +.. attribute:: BROWSERID_ENABLED + + :default: False + + When this variable is True, Colab use BrowserID authentication. By default, + django authentication system is used. + +.. attribute:: BROWSERID_AUDIENCES + + :default: No default + + List of audiences that your site accepts. An audience is the protocol, + domain name, and (optionally) port that users access your site from. This + list is used to determine the audience a user is part of (how they are + accessing your site), which is used during verification to ensure that the + assertion given to you by the user was intended for your site. + + Without this, other sites that the user has authenticated with via Persona + could use their assertions to impersonate the user on your site. + + Note that this does not have to be a publicly accessible URL, so local URLs + like ``http://localhost:8000`` or ``http://127.0.0.1`` are acceptable as + long as they match what you are using to access your site. + +Customization +------------- +Home Page ++++++++++ +.. TODO + +Menu +++++ +.. TODO + +Templates ++++++++++ +.. TODO -- libgit2 0.21.2