Index: branches/PublicaMundi_David-devel/docs/contribute/code.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/contribute/code.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/contribute/code.rst (revision 663) @@ -1,14 +1,62 @@ +.. _contribute_code: + Contribute code =============== -Anybody is welcome to share and contribute ideas, code, documentation or any relevant resource -using the following media. +Anybody is welcome to share source code and to report bugs or feature requests using the following instructions. Submit new code -------------------------- +For new comers +************************* -Report a code issue +New source code or existing source code corrections (patches) should be submitted using the ZOO-Project bug tracking system (ZOO-Trac). + +Create a new ticket in order to describe your code or patch and attach it to the ticket (attach all the needed files needed to use your code or patch). It will then be checked and discussed with the developers, and can potentially be merged with the trunk. + +For registered developers +*************************** + +ZOO-Project registered developers have direct svn access and can: + +* Commit fixes, enhancement and new source directly to trunk + +* Create and commit to a new branch of the svn + +Bug tracking -------------------------- +General information +********************* +Bug reports and wishes can be submitted using the ZOO-Trac. This requires you to setup a user account (userid) using this section. + +The following trackers are available: + +* *defects* to report bugs and 'bad' features +* *enhancement* to describe feature wishes +* *task* to describe any different but relevant topic. + +The following components are available: + +* *Developemnt platform* to report bugs and 'bad' features +* *ZOO-Kernel* to report a bug or problem with the ZOO-Project WPS server +* *ZOO-Services* to report a bug or problem with the ZOO-Project WPS services +* *ZOO-API* to report a bug or problem with the ZOO-Project API +* *ZOO-Client* to report a bug or problem with the ZOO-Project Client +* *Documentation* to report a problem or suggest an enhancement to the documentation + +Best practices +********************* + +Please consider the following when submitting bugs or feature requests: + +* Check if the bug is still persistent in svn trunk before reporting. If you use an older version, please consider upgrading. +* Before reporting a bug, please search if it is yet unknown in the bug tracking system. +* Give an appropriate, starightforward and understandable title to your ticket using the *Summary* field +* Make sure the developers get all the needed information to recreate the bug using the *Description* field (e.g. tell about your configuration and explain every step to reproduce the bug). +* Select at least a *Type* of tracker and a *Component* for your new ticket. +* Report only one single bug by ticket. + + Index: branches/PublicaMundi_David-devel/docs/contribute/doc.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/contribute/doc.rst (revision 663) +++ branches/PublicaMundi_David-devel/docs/contribute/doc.rst (revision 663) @@ -0,0 +1,160 @@ +.. _contribute_doc: + +Contribute documentation +================== + +ZOO Documentation is a collaborative process managed by the ZOO develoeprs. Anybody is welcome to contribute to the ZOO-Project documentation. Please consider the following instructions before doing so. + +For new comers +************************* + +New users are encouraged to contribute documentation using the following ways: + +* Download the ZOO-Project svn, edit the documentation files located /docs directory and share the modifications through a new ticket set to 'Documentation' tracker +* Create a wiki page containg new or corrected documentation text, and create a new ticket to report its creation. + +The ZOO developers responsible for the documentation will then review the contributions to add them into the official docs. + +For registered developers +**************************** + +The current structure of the ZOO Project documentation process is for developers with :ref:`SVN ` commit access to maintain their documents in reStructuredText format, and therefore all documents live in the /docs directory in SVN. The `Sphinx `__ documentation generator is used to convert the reStructuredText files to html, and the live +website is then updated on an hourly basis. + + +Installing and using Sphinx +------------------------ + +On Linux +*********** + +* Make sure you have the Python dev and setuptools packages installed. + On Ubuntu: + + :: + + sudo apt-get install python-dev + sudo apt-get install python-setuptools + +* Install sphinx using easy_install: + + :: + + sudo easy_install Sphinx + + .. note:: + + Make sure you install Sphinx 1.0 or more recent. See note above. + +* Checkout the /docs directory from SVN, such as: + + :: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +* To process the docs, from the ZOO /docs directory, run: + + :: + + make html + + or + + :: + + make latex + + The HTML output will be written to the build/html sub-directory. + +.. note:: + + If there are more than one translation, the above commands will automatically + build all translations. + + +On Mac OS X +**************** + +* Install sphinx using easy_install: + + :: + + sudo easy_install Sphinx + + .. note:: + + Make sure you install Sphinx 1.0 or more recent. See note above. + +* Install `MacTex `__ if you want to build pdfs + +* Checkout the /docs directory from SVN, such as: + + :: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +* To process the docs, from the ZOO /docs directory, run: + + :: + + make html + + or + + :: + + make latex + + The HTML output will be written to the build/html sub-directory. + + +On Windows +************** + +* Install `Python 2.X `__ +* Download `setuptools `__ +* Make sure that the ``C:/Python2X/Scripts`` directory is your path +* Execute the following at commandline: + + :: + + easy_install Sphinx + + ...you should see message: "Finished processing dependencies for Sphinx" + + .. note:: + + Make sure you install Sphinx 1.0 or more recent. See note above. + +* Install `MiKTeX `__ if you want to build pdfs + +* Checkout the /docs directory from SVN, such as: + + :: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +* Inside the /docs directory, execute: + + :: + + make html + + or + + :: + + make latex + + The HTML output will be written to the _build/html sub-directory. + + +reStructuredText Reference Guides +*************************************** + +The following resources are considered as useful for editing and creating new ZOO-Project documentation files. + +- Docutils `Quick reStructuredText `__ +- Docutils `reStructuredText Directives `__ +- Sphinx's `reStructuredText Primer `__ +- search Sphinx's `mailing list `__ Index: branches/PublicaMundi_David-devel/docs/contribute/howto.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/contribute/howto.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/contribute/howto.rst (revision 663) @@ -2,46 +2,36 @@ ================== -Please consider the following simple rules if you would like to -contribute to `ZOO-Project `__ . - +Please consider the following simple rules if you would like to contribute to the `ZOO-Project `__ open source software. Community ------------------- -Anybody is welcome to share and contribute ideas, code, documentation -or any relevant resource. This should be done according to the directives stated in the ZOO-Project :ref:`contribute_index`. +Anybody is welcome to share and contribute ideas, code, documentation or any relevant resource. This should be done according to the directives stated in the ZOO-Project :ref:`contribute_index`. + +Governance +...................................... + +`ZOO-Project `__ activities are directed by the Project Steering Committee (PSC) and the software itself is being developed, maintained and documented by an international community of users and developers (aka `ZOO-Tribe `_). + +Contributions are moderated and integrated in trunk at the discretion of the `ZOO-Project `__ PSC. Commit access are usually granted to active contributors by vote from the PSC members. Licensing ...................................... -`ZOO-Project `__ source code is open source and -made available under the `MIT/X-11 -`__ `license -`__. You -must agree to the terms of that same license when creating, submiting -and releasing new source code. +`ZOO-Project `__ source code is open source and made available under the `MIT/X-11 `__ `license +`__. You must agree to the terms of that same license when creating, submiting and releasing new source code. -`ZOO-Project `__ documentation is open source and -made available under the `Creative Commons Attribution-ShareAlike 4.0 International Public License -`__ . You -must agree to the terms of that same license when creating, submiting -and releasing a new documentation file. - - -Governance -...................................... - - +`ZOO-Project `__ documentation is open source and made available under the `Creative Commons Attribution-ShareAlike 4.0 International Public License +`__ . You must agree to the terms of that same license when creating, submiting and releasing a new documentation file. Available media ------------------- -Discussions and contributions are encouraged using the following media +Discussions and contributions to `ZOO-Project `__ are encouraged using the following public media. Mailing lists ...................................... -Post any feedback, comment or idea to the general public mailing -list. For project managment or governance topics, use the PSC list. +Feel free to post any question, feedback, comment or idea to the general public mailing list. For project managment or governance topics, please use the PSC list. .. csv-table:: @@ -55,12 +45,14 @@ ...................................... -Join #zoo-project channel on irc.freenode.net to discuss with the ZOO-Tribe +Join the **#zoo-project** channel on irc.freenode.net to discuss with the ZOO-Tribe at any time. -Tracker and wiki +Tracker ...................................... -Contributions and bug reports should be shared using the `ZOO-Project -`__ bug tracking system, as specified in the -:ref:`contribute-code` section. Wiki pages can also be created to -describe contributions and or actions. +Bug reports and code patches should be shared using the `ZOO-Project `__ bug tracking system, as specified in the :ref:`contribute-code` section. + +Wiki +...................................... + +Wiki pages can also be created by registered users. They can be used in order to describe any concept, contribution and or action that benefits or is related to the project. Index: branches/PublicaMundi_David-devel/docs/contribute/index.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/contribute/index.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/contribute/index.rst (revision 663) @@ -15,2 +15,3 @@ howto code + doc