Update doc for github

Author: Ovv

CONTRIBUTING.rst

@@ -6,10 +6,13 @@ Contributing
 
 First off, thanks for taking the time to contribute!
 
-Contributions are welcome by anybody and everybody. We are not kidding!
+Contributions are welcome by anybody and everybody. We are not kidding! Looking for help ? Join us on `Slack`_ by requesting an `invite`_.
 
 The rest of this document will be guidelines to contributing to the project. Remember that these are just guidelines, not rules. Use common sense as much as possible.
 
+.. _invite: http://pythondevelopers.herokuapp.com/
+.. _Slack: https://pythondev.slack.com/
+
 Pull Request Guidelines
 -----------------------
 
@@ -31,7 +34,7 @@ Types of Contributions
 Report Bugs
 ^^^^^^^^^^^
 
-Report bugs at https://gitlab.com/PythonDevCommunity/sir-bot-a-lot/issues.
+Report bugs at https://github.com/pyslackers/sir-bot-a-lot/issues.
 
 If you are reporting a bug, please include:
 
@@ -42,26 +45,21 @@ If you are reporting a bug, please include:
 Bugs & Features
 ^^^^^^^^^^^^^^^
 
-Look through the gitlab issues for bugs or features request.
-Anything tagged with "bug" or "enhancement" is open to whoever wants to implement it.
+Look through the github issues for bugs or features request.
+Anything tagged with "help-wanted" is open to whoever wants to implement it.
 
-At this point you might want to pop on the #bots and #community-projects channel of the `python developers slack community`_.
-Request an `invite`_.
-
-.. _invite: http://pythondevelopers.herokuapp.com/
-.. _python developers slack community: https://pythondev.slack.com/
 
 Write Documentation
 ^^^^^^^^^^^^^^^^^^^
 
-sir-bot-a-lot could always use more documentation, whether as part of the
-official sir-bot-a-lot docs, in docstrings, or even on the web in blog posts,
+Sir Bot-a-lot could always use more documentation, whether as part of the
+official Sir Bot-a-lot docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
 ^^^^^^^^^^^^^^^
 
-The best way to send feedback is to file an issue at https://gitlab.com/PythonDevCommunity/sir-bot-a-lot/issues.
+The best way to send feedback is to file an issue at https://github.com/pyslackers/sir-bot-a-lot/issues.
 
 If you are proposing a feature:
 
@@ -75,12 +73,12 @@ Get Started!
 
 Ready to contribute? Here's how to set up `sir-bot-a-lot` for local development.
 
-1. Fork the `sir-bot-a-lot` repo on gitlab.
+1. Fork the `sir-bot-a-lot` repo on github.
 2. Clone your fork locally:
 
    .. code-block:: console
 
-       $ git clone git@gitlab.com:your_name_here/sir-bot-a-lot.git
+       $ git clone git@github.com:<username>/sir-bot-a-lot.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
 
@@ -106,15 +104,15 @@ Ready to contribute? Here's how to set up `sir-bot-a-lot` for local development.
 
    To get tox, just pip install it into your virtualenv.
 
-6. Commit your changes and push your branch to gitlab:
+6. Commit your changes and push your branch to github:
 
 .. code-block:: console
 
        $ git add .
        $ git commit -m "Your detailed description of your changes."
        $ git push origin name-of-your-bugfix-or-feature
 
-7. Submit a pull request through the gitlab website.
+7. Submit a pull request through the github website.
 
 Git Hygiene
 -----------

HISTORY.rst

@@ -5,4 +5,4 @@ History
 2016-08-20
 ----------
 
-Initial commit of Sir-bot-a-lot
+Initial commit of Sir Bot-a-lot

docs/usage.rst docs/configuration.rst

@@ -1,11 +1,11 @@
-=====================
-Usage & Configuration
-=====================
+=============
+Configuration
+=============
 
 Command Line
 ------------
 
-To start Sir-bot-a-lot you can use:
+To start Sir Bot-a-lot you can use:
 
 .. code-block:: console
 
@@ -18,30 +18,31 @@ or:
     $ python run.py
 
 
-
 Arguments
 ^^^^^^^^^
 
 The command line arguments take precedence over the configuration file.
 
 * :code:`-h --help`: Help message
-* :code:`-p --port`: Port where to run Sir-bot-a-lot
-* :code:`-c --config`: Path to Sir-bot-a-lot Yaml config file
+* :code:`-P --port`: Port where to run Sir Bot-a-lot
+* :code:`-c --config`: Path to Sir Bot-a-lot Yaml config file
+* :code:`-u --update`: Perform update migration if necessary (i.e. database)
+* :code:`-p --plugins`: Plugins to start
 
 
 Environment variables
 ---------------------
 The environment variable take precedence over the command line arguments and the
 configuration file.
 
-* :code:`SIRBOT_PORT`: Port where to run Sir-bot-a-lot
-* :code:`SIRBOT_CONFIG`: Path to Sir-bot-a-lot Yaml config file
+* :code:`SIRBOT_PORT`: Port where to run Sir Bot-a-lot
+* :code:`SIRBOT_CONFIG`: Path to Sir Bot-a-lot Yaml config file
 
 
 Configuration file
 ------------------
 
-Sir-bot-a-lot configuration is a Yaml file containing the core and all the
+Sir Bot-a-lot configuration is a Yaml file containing the core and all the additional
 plugins configuration.
 
 The environment variable and command line arguments take precedence over the
@@ -51,41 +52,37 @@ A basic configuration will look like this:
 
 .. code-block:: yaml
 
-    port: 8080
-
-    core:
-      plugins:
-      - plugin-1
-      - plugin-2
+.. code-block:: yaml
 
-    plugin-1:
+    sirbot:
+        port: 8080
+        plugins: []
+    plugin1:
         ...
-
-    plugin-2:
+    plugin2:
         ...
 
 Starting priority
 ^^^^^^^^^^^^^^^^^
 
-As plugins can depend on other plugins startup is done by priority. By default all plugins have a priority of 50.
-Plugins with a higher priority will start before the one with a lower priority.
+Plugins can be dependant on other plugins. You can ensure a startup order by setting a startup priority. By default all plugins have a priority of 50. Plugins with a higher priority will start before the one with a lower priority.
 
-If multiple plugins have the same priority they will start at the same time.
+If multiple plugins have the same priority they will start simultaneously.
 
 The priority can be set to false to disable a plugin.
 
 .. code-block:: yaml
 
-    plugin-1:
+    plugin1:
         priority: 80
-    plugin-2:
+    plugin2:
         priority: False
 
 Logging
 ^^^^^^^
 
 Logging can be configured in the :code:`logging` key of the configuration file.
-It use the logging module `dictionnary configuration`_.
+It use the logging module `dictionnary configuration`_. By default the log level is set to :code:`INFO`.
 
 Each plugin should define his own logger. The core logger is :code:`sirbot.core`.
 

docs/facade.rst

@@ -2,13 +2,12 @@
 Facade
 ======
 
-The MainFacade object is the way to access other plugin functionality.
-Each plugin should expose a facade.
-
-To request a plugin facade:
+The facade manager is the way to access other plugin functionality by requesting a plugin facade:
 
 .. code-block:: python
 
-    plugin_facade = main_facade.get('my_plugin')
+    plugin_facade = facade.get('my_plugin')
+
+A new plugin facade is created for each call to the :code:`Facade.get` method
 
-A new plugin facade is created for each called to the :code:`MainFacade.get` method
+Each incoming request should create a new facade manager object by calling :code:`facade.new()`

docs/index.rst

@@ -4,18 +4,18 @@
    contain the root `toctree` directive.
 
 =========================================
-Welcome to sir-bot-a-lot's documentation!
+Welcome to Sir Bot-a-lot's documentation!
 =========================================
 
-A slack bot built for the people and by the people of the `python developers slack community`_.
+An asynchronous bot framework built for the people and by the people of the `python developers slack community`_.
 Want to join? `Get an invite`_ !
 
 .. toctree::
    :maxdepth: 2
 
    quickstart
    installation
-   usage
+   configuration
    plugins
    facade
    contributing

docs/plugins.rst

@@ -10,39 +10,54 @@ Available plugins
 -----------------
 
  * `Slack`_
- * `Pythondev plugins repositorie`_
+ * `Github`_
+ * `SQLite`_
+ * `Others`_
 
-.. _Slack: http://sirbot-plugin-slack.readthedocs.io/en/latest/
-.. _Pythondev plugins repositorie: https://gitlab.com/PythonDevCommunity/sirbot-plugin
+.. _Slack: https://github.com/pyslackers/sirbot-slack
+.. _Github: https://github.com/pyslackers/sirbot-plugins
+.. _SQLite: https://github.com/pyslackers/sirbot-plugins
+.. _Others: https://github.com/pyslackers/sirbot-plugins
 
 .. _writing_plugins:
 
 Writing plugins
 ---------------
 
-Sir-bot-a-lot is build onto the `pluggy`_ library for plugins management.
+Sir Bot-a-lot is build onto the `pluggy`_ library for plugin management.
 
 .. _pluggy: https://github.com/pytest-dev/pluggy
 
 
-A plugin must define one hook returning the plugin name and a subclass of the plugin class.
+A plugin must define one hook returning a subclass of the plugin class.
 
 .. literalinclude:: ../sirbot/hookspecs.py
 
 
 .. literalinclude:: ../sirbot/plugin.py
 
 
+Facade
+^^^^^^
+
+If needed a plugin can expose a facade to Sir Bot-a-lot allowing other plugins access to its functionality.
+
+A new facade instance is created each time a plugin request it.
+
 Example
 ^^^^^^^
 
-The `giphy`_ plugin provide a simple facade for the `Giphy.com`_ API.
+The `pypi`_ plugin provide a simple facade for the `Python Package Index`_ API.
 It can be retrieve inside another plugin with:
 
 .. code-block:: python
-
-    facades.get('giphy')
-
-
-.. _giphy: https://gitlab.com/PythonDevCommunity/sirbot-plugin/blob/master/sirbot_plugin/giphy.py
-.. _Giphy.com: http://giphy.com/
+    
+    # Create a new giphy facade by calling 
+    # PyPIPlugin.facade()
+    pypi = facades.get('pypi')
+    
+    # The pypi plugin facade only expose the search function
+    result = await pypi.search('sir-bot-a-lot')
+
+.. _pypi: https://github.com/pyslackers/sirbot-plugins/blob/master/sirbot/plugins/pypi.py
+.. _Python Package Index: https://pypi.python.org/pypi

docs/quickstart.rst

@@ -2,34 +2,14 @@
 Quick Start
 ===========
 
-|build| |coverage| |doc|
-
-A slack bot built for the people and by the people of the `python developers slack community`_.
-
-Want to join? `Get an invite`_ !
-
-.. _Get an invite: http://pythondevelopers.herokuapp.com/
-.. _python developers slack community: https://pythondev.slack.com/
-.. |build| image:: https://gitlab.com/PythonDevCommunity/sir-bot-a-lot/badges/master/build.svg
-    :alt: Build status
-    :scale: 100%
-    :target: https://gitlab.com/PythonDevCommunity/sir-bot-a-lot/commits/master
-.. |coverage| image:: https://gitlab.com/PythonDevCommunity/sir-bot-a-lot/badges/master/coverage.svg
-    :alt: Coverage status
-    :scale: 100%
-    :target: https://gitlab.com/PythonDevCommunity/sir-bot-a-lot/commits/master
-.. |doc| image:: https://readthedocs.org/projects/sir-bot-a-lot/badge/?version=latest
-    :alt: Documentation status
-    :target: http://sir-bot-a-lot.readthedocs.io/en/latest/?badge=latest
-
 Installation
 ------------
 
-The sources for sir-bot-a-lot can be downloaded from the `gitlab repo`_.
+The sources for Sir Bot-a-lot can be downloaded from the `github repo`_.
 
 .. code-block:: console
 
-    $ git clone git://gitlab.com/PythonDevCommunity/sir-bot-a-lot
+    $ git clone https://github.com/pyslackers/sir-bot-a-lot.git
 
 Once you have a copy of the source, you can install it with:
 
@@ -39,39 +19,31 @@ Once you have a copy of the source, you can install it with:
 
 More installation instruction can be found :ref:`here <installation>`.
 
-.. _gitlab repo: https://gitlab.com/PythonDevCommunity/sir-bot-a-lot
+.. _github repo: https://github.com/pyslackers/sir-bot-a-lot
 
 Run
 ---
 
-To start Sir-bot-a-lot use the command
+To start Sir Bot-a-lot use the command
 
 .. code-block:: console
 
     $ sirbot
 
-By default no plugins are installed so Sir-bot-a-lot will not do anything.
+By default no plugins are installed so Sir Bot-a-lot will not do anything.
 Check out the :ref:`available plugins page <available_plugins>`.
 
 Configuration
 -------------
 
-The configuration file is where you tell which plugins to be load.
+To load a custom config file use the :code:`--config` argument or the :code:`SIRBOT_CONFIG` environment variable with the configuration file path.
 
-A basic configuration will look like this:
+The default configuration file look like this:
 
 .. code-block:: yaml
 
-    loglevel: 10
+    sirbot:
     port: 8080
-    core:
-      loglevel: 10
-      plugins:
-      - plugin-1
-      - plugin-2
-
-    plugin-1:
-      loglevel: 10
-
-    plugin-2:
-      loglevel: 10
+    plugins: []
+    
+Plugins can also be added with the `--plugins` argument