dev guide updated

bird-house · Sep 8, 2018 · a67fe6b · a67fe6b
1 parent cef21b5
commit a67fe6b
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 17 deletions.
diff --git a/docs/source/appendix.rst b/docs/source/appendix.rst
@@ -9,6 +9,8 @@ Useful Links
 WPS Documentation
 =================
 
+.. Warning: outdated
+
 * `What is WPS? <http://geoprocessing.info/wpsdoc/Concepts#what>`_
 * `WPS on OSGeo Live <http://download.osgeo.org/livedvd/doc-dev/standards/wps_overview.html>`_
 * `WPS tutorial <http://wiki.ieee-earth.org/Documents/GEOSS_Tutorials/GEOSS_Provider_Tutorials/Web_Processing_Service_Tutorial_for_GEOSS_Providers/Section_2:_Introduction_to_WPS>`_

diff --git a/docs/source/dev_guide.rst b/docs/source/dev_guide.rst
@@ -5,7 +5,7 @@ Developer Guidelines
 
 .. contents::
     :local:
-    :depth: 3
+    :depth: 2
 
 The Birdhouse project openly welcomes contributions (bug reports, bug fixes, code enhancements/features, etc.). This document will outline some guidelines on contributing to birdhouse. As well, the birdhouse :ref:`communication` is a great place to get an idea of how to connect and participate in birdhouse community and development where everybody is welcome to rise questions and discussions.
 
@@ -20,14 +20,30 @@ accordance with the `OSGeo Code of Conduct`_.
 
 Contribution Workflow
 ---------------------
+Everybody is welcome to contribute to birdhouse. Here are some basic guides to smoothly contribute:
+
+.. _source_code:
+
+Source code
+...........
+The source code of all birdhouse components is available on GitHub_. Respecting the git mechanisms you can fork, clone and pull source-code into your repositories for modification and enhancement. Once your improvement is ready, make a pull request to integrate your work into the origin birdhouse repositories.
+
+.. note: Please keep your forks close to the origin repositories and don't forget the pull requests.
+
+.. _issuetracker:
+
+Issue tracker
+.............
+
+To keep track on the contribution and development, please use the issue tracker on GitHub for the corresponding birdhouse component.
 
-.. todo:: The coding guide needs to be updated.
 
 Please find the coding guide in the
 `Wiki <https://github.com/bird-house/bird-house.github.io/wiki/Development-Guidelines>`_.
 
 
 .. _codestyle:
+
 Python Code Style (PEP8)
 ------------------------
 
@@ -141,6 +157,16 @@ The main `documentation`_ (which you are reading now) is the starting point to
 get an overview of birdhouse. Each birdhouse component comes with
 its own Sphinx documentation and is referenced by the main birdhouse document.
 
+
+
+.. _conda:
+Environment with conda
+----------------------
+.. todo: How to create a conda package
+
+
+
+
 .. _`OSGeo Code of Conduct`: http://www.osgeo.org/code_of_conduct
 .. _`documentation`: https://github.com/bird-house/birdhouse-docs
 .. _`GitHub`: https://github.com/bird-house

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,3 +17,4 @@
    release_notes
    license
    glossary
+   appendix
diff --git a/docs/source/snippetstobesorted.rst b/docs/source/snippetstobesorted.rst
@@ -1,20 +1,7 @@
-.. _conda:
-
-
-.. _source:
-Source code
------------
-
-The source code of all birdhouse components is available on GitHub_.
-
-.. _issuetracker:
-Issue tracker
--------------
-
-Please use the issue tracker on GitHub for the corresponding birdhouse component.
 
 
 Website development
 -------------------
 
-The birdhouse website is on http://bird-house.github.io/. The HTML pages are `maintained on GitHub <https://github.com/bird-house/bird-house.github.io>`_.
+The birdhouse website is on http://bird-house.github.io/.
+The HTML pages are `maintained on GitHub <https://github.com/bird-house/bird-house.github.io>`_.