Merge branch 'docs'

docs/source/ContributionGuide.rst

@@ -4,6 +4,22 @@ Contribution and Community Guide
 
 Useful pointers on how to participate of the Avocado community and contribute.
 
+.. _hacking-and-using:
+
+Hacking and Using Avocado
+=========================
+
+Since version 0.31.0, our plugin system requires Setuptools entry points to be
+registered. If you're hacking on Avocado and want to use the same, possibly modified,
+source for running your tests and experiments, you may do so with one additional step::
+
+  $ python setup develop --user
+
+On POSIX systems this will create an "egg link" to your original source tree under
+"$HOME/.local/lib/pythonX.Y/site-packages". Then, on your original source tree, an
+"egg info" directory will be created, containing, among other things, the Setuptools
+entry points mentioned before.
+
 Contact information
 ===================
 
@@ -23,11 +39,9 @@ take place in the Pull Request as well.
 For people who don't like the github development model, there is the option
 of sending the patches to the Mailing List, following a workflow more
 traditional in Open Source development communities. The patches will be
-reviewed in the Mailing List, should you opt for that.
-
-As soon as we have a mailing list functional, just send
-patches to the list, and we'll have a sub-maintainer that will collect the
-patches, integrate them on a branch, and then those patches will be submitted
-as a github Pull Request. This process tries to ensure that every contributed
-patch goes through the CI jobs before it is considered good for inclusion.
+reviewed in the Mailing List, should you opt for that. Then a maintainer will
+collect the patches, integrate them on a branch, and then those patches will
+be submitted as a github Pull Request. This process tries to ensure that every
+contributed patch goes through the CI jobs before it is considered good for
+inclusion.
 

docs/source/GetStartedGuide.rst

@@ -68,7 +68,7 @@ Note that `python` and `pip` should point to the Python interpreter version 2.7.
 If you're having trouble to install, you can try again and use the command line
 utilities `python2.7` and `pip2.7`.
 
-For Debian users, use `apt-get` to install the proper dependencies that `yum` installs.
+If you intend to hack on Avocado, you may want to look at :ref:`hacking-and-using`.
 
 Using Avocado
 =============

docs/source/index.rst

-======================
-Avocado Test Framework
-======================
+====================
+Avocado User's Guide
+====================
 
 Contents:
 
@@ -18,6 +18,14 @@ Contents:
    DebuggingWithGDB
    WrapProcess
    Plugins
+
+===============================
+Advanced Topics and Maintenance
+===============================
+
+.. toctree::
+   :maxdepth: 2
+
    ReferenceGuide
    ContributionGuide
    DevelopmentTips
@@ -25,7 +33,6 @@ Contents:
 
 .. _api-reference:
 
-
 =============
 API Reference
 =============