Commits

Greg Salt committed 7b05e70

Splitting Getting Started into separate page

Comments (0)

Files changed (5)

 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {'stickysidebar': 'true'}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []

docs/developers.rst

+Developers
+==========
+
+We have made a library available that makes it easy for you to integrate Cerberus into your own addons. It is released under the MIT licence so you can use it for commercial purposes if required.
+
+

docs/getting-started.rst

+Getting Started
+===============
+
+Getting started with Project Cerberus is easy. Just follow these steps:
+
+1. `Create an account <https://projectcerberus.com/account/register>`_
+
+   This allows you to register any sites you wish to use with Cerberus. When you register a site you get a unique access key that is used to encrypt your data when it is sent to the central database. See :doc:`registration` for more information.
+
+2. Download the addon you need
+
+   We provide a extension for EE 2.x called :doc:`updater` that is triggered when you move a member into the banned group. There is also an extension that complements `Member Utilities 1.x <http://devot-ee.com/add-ons/member-utilities>`_. Unfortunately there is no standalone extension for ExpressionEngine 1.x.
+
+3. Use your site as normal
+
+   With either of the above extensions installed you can carry on using your site as you always do. As part of your routine member administration whenever you ban a spam member you will be helping to populate our database.
+
+
 
 This is a realtime network. If you send an update to Cerberus then that data immediately becomes available to everyone else who has any of the Cerberus components installed and active.
 
-Getting Started
----------------
+.. toctree::
+   :maxdepth: 0
 
-Getting started with Project Cerberus is easy. Just follow these steps:
-
-1. `Create an account <https://projectcerberus.com/account/register>`_
-
-   This allows you to register any sites you wish to use with Cerberus. When you register a site you get a unique access key that is used to encrypt your data when it is sent to the central database. See :doc:`registration` for more information.
-
-2. Download the addon you need
-
-   We provide a extension for EE 2.x called :doc:`updater` that is triggered when you move a member into the banned group. There is also an extension that complements `Member Utilities 1.x <http://devot-ee.com/add-ons/member-utilities>`_. Unfortunately there is no standalone extension for ExpressionEngine 1.x.
-
-3. Use your site as normal
-
-   With either of the above extensions installed you can carry on using your site as you always do. As part of your routine member administration whenever you ban a spam member you will be helping to populate our database.
-
-.. Contents:
-
-    .. toctree::
-       :maxdepth: 2
+   getting-started.rst
+   registration.rst
+   updater.rst
 
 
 
 
 There are 4 configuration settings for the extension:
 
-Enable Cerberus Updater for this site?
+:Enable Cerberus Updater for this site?:
     You can turn Cerberus Updater on or off without losing your settings
 
-Empty member profile when banned?
+:Empty member profile when banned?:
     You can choose to have the member URL, biography and signature fields emptied when moving a member into the banned group.
 
-Added banned member details to ban lists?
+:Added banned member details to ban lists?:
     This setting automatically populates the standard EE member ban lists with the banned member username, email and IP address.
 
     .. attention::
         
         Be careful with this setting. It is off by default and unless you **really** need this we recommend keeping this off. The reason is that these lists will soon get very big and it all has to be loaded from disk on each page load.
 
-Cerberus Updater access key
+:Cerberus Updater access key:
     The access key that you generated for your site. This is used to encrypt the data that is sent to the Cerberus database and it is tied to your site hostname.
 
 ExpressionEngine 1.x