Skip to content

Commit

Permalink
contributing page added
Browse files Browse the repository at this point in the history
  • Loading branch information
cehbrecht committed Mar 12, 2015
1 parent b33f016 commit 983d1ca
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 6 deletions.
56 changes: 56 additions & 0 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
.. _contributing:

Contributing
============

Birdhouse is at an early stage. Things are not clearly setup yet.
The main contributions can be provided via GitHub issues and providing patches.
You can also register on the mailing list to retrieve announcements.

Mailing list
------------

News are published to the `wps mailing list <https://lists.dkrz.de/mailman/listinfo/wps>`_. Feel free to register.

Source code
-----------

The source code of all Birdhouse components is available on `our Github page <http://github.com/bird-house>`_.

Issue tracker
-------------

Please use the issue tracker on GitHub for the corresponding Birdhouse component.

WPS client side:

* `Phoenix web application <https://github.com/bird-house/pyramid-phoenix/issues>`_
* `Birdy command line WPS client <https://github.com/bird-house/birdy/issues>`_

WPS server side:

* `Malleefowl WPS base processes to access data <https://github.com/bird-house/malleefowl/issues>`_
* `Flyingpigeon WPS for climate impact <https://github.com/bird-house/flyingpigeon/issues>`_

Build tools:

* `Birdhouse Builder Bootstrap <https://github.com/bird-house/birdhousebuilder.bootstrap/issues>`_

Wiki
----

The `Wiki on GitHub <https://github.com/bird-house/bird-house.github.io/wiki>`_ is used for topics not covered by the Sphinx documentation yet.


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>`_.


Documentation
-------------

The documentation is created with `Sphinx <http://sphinx-doc.org/index.html>`_ and is automatically published to `ReadTheDocs <https://readthedocs.org/>`_ with GitHub webhooks.

The `main documentation <https://github.com/bird-house/birdhouse-docs>`_ (which you are reading now) is the starting point to get an overview of what Birdhouse provides. Each Birdhouse component comes with its own Sphinx documentation and is referenced by the main Birdhouse document.
7 changes: 1 addition & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,13 @@ Getting started
overview
installation
tutorial
contributing
faq
glossary
release_notes
roadmap
appendix


Getting involved
================

News are published to the `wps mailing list <https://lists.dkrz.de/mailman/listinfo/wps>`_

Presentations & Blog Posts
==========================

Expand Down

0 comments on commit 983d1ca

Please sign in to comment.