Author: poeml Date: Fri Jul 31 19:12:03 2009 New Revision: 7741 URL: http://svn.mirrorbrain.org/viewvc/mirrorbrain?view=revision&revision=7741 Log: docs: add some introductory documentation for developers. Modified: trunk/docs/devel/developer.rst trunk/docs/intro.rst Modified: trunk/docs/devel/developer.rst ============================================================================== --- trunk/docs/devel/developer.rst Fri Jul 31 14:38:14 2009 (r7740) +++ trunk/docs/devel/developer.rst Fri Jul 31 19:12:03 2009 (r7741) @@ -1,31 +1,45 @@ +Documentation for Developers +============================ -******************************************************************************** -How to contribute -******************************************************************************** -To be written. +If you are contributing to the MirrorBrain project, please read this first. + + +Participating in the community +------------------------------ + +The community exists mainly through mailing lists and a Subversion repository. +To participate: + +Go to http://mirrorbrain.org/communication/ and join the "mirrorbrain", +"mirrorbrain-commits", and "mirrorbrain-announce" mailing lists. The dev list, +"mirrorbrain", is where almost all discussion takes place. All development +questions should go there, though you might want to check the list archives +first. The "mirrorbrain-commits" list receives automated commit emails. + +Get a copy of the latest development sources from +http://svn.mirrorbrain.org/svn/mirrorbrain/trunk/. New development always +takes place on trunk. Bugfixes, enhancements, and new features might be +backported from there to the various release branches. + +How to work on the documentation is described in :ref:`hacking_the_docs`. -******************************************************************************** Hacking on the apache modules -******************************************************************************** +----------------------------- To be written. - -******************************************************************************** Writing extensions for the Python module -******************************************************************************** +---------------------------------------- To be written. - -******************************************************************************** Debugging notes -******************************************************************************** +--------------- To be written. Modified: trunk/docs/intro.rst ============================================================================== --- trunk/docs/intro.rst Fri Jul 31 14:38:14 2009 (r7740) +++ trunk/docs/intro.rst Fri Jul 31 19:12:03 2009 (r7741) @@ -9,6 +9,8 @@ `here <http://svn.mirrorbrain.org/viewvc/mirrorbrain/trunk/docs/>`_. +.. _hacking_the_docs: + How to improve this documentation --------------------------------- _______________________________________________ mirrorbrain-commits mailing list Archive: http://mirrorbrain.org/archive/mirrorbrain-commits/ Note: To remove yourself from this list, send a mail with the content unsubscribe to the address mirrorbrain-commits-request_at_mirrorbrain.orgReceived on Fri Jul 31 2009 - 17:12:05 GMT
This archive was generated by hypermail 2.2.0 : Fri Jul 31 2009 - 17:45:06 GMT