-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Stefano David
committed
May 16, 2018
1 parent
db90603
commit 7d65d5a
Showing
2 changed files
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
How To Contribute | ||
================= | ||
|
||
There are different possibilities to participate in the |odh| Project, | ||
including -but not limited to- to report bugs in the API or errors in | ||
the API output, to ask for more datasets to be added to our | ||
repository, to make feature requests or suggestions for improvement. | ||
|
||
Depending on your interest on the |odh| Project, we also welcome your | ||
participation to the project as either a developer or user. | ||
|
||
I am a user | ||
----------- | ||
|
||
As a user, simply go to the list of :doc:`catalogue`, choose a dataset | ||
and start gathering data from it, by using the documentation provided | ||
in this site. You can then report any malfunctions, suggest new | ||
methods that could be implemented, and so on. | ||
|
||
I am a developer | ||
---------------- | ||
|
||
As a developer, you can actively participate in the development of | ||
|odh| or build your own application on top of the API and the code and | ||
datasets that we provide. | ||
|
||
Before doing so, however, you first need to fulfil a few requirements | ||
in order to set up your PC, VM, or docker instance and be able to use | ||
the |odh| coda and API. | ||
|
||
Requirements | ||
~~~~~~~~~~~~ | ||
|
||
You need the following software: | ||
|
||
* PostgreSQL 9.3 or higher with postgis 2.2 extension. | ||
* An application server (tomcat8 suggested) | ||
* JRE7 or higher (JRE8 suggested) | ||
|
||
You can then set up PostgreSQL, clone the git repository, and finally | ||
clone our :strong:`HelloWorld` sample repository. | ||
|
||
The complete howto can be found :doc:`here <howto/developer>`. (TBD | ||
after issue #30 has been completed) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
.. _tutorial-devel: | ||
|
||
How to set up a DTO locally | ||
=========================== | ||
|
||
This tutorial will guide you in the set up of the local infrastructure | ||
to be able to deploy a new Data Collector Object starting fro ma | ||
simple :strong:`HelloWorld` template we provide. | ||
|
||
You need the following software: | ||
|
||
* PostgreSQL 9.3 or higher with postgis 2.2 extension. | ||
* An application server (tomcat8 suggested) | ||
* JRE7 or higher (JRE8 suggested) | ||
|
||
.. todo:: Once the requirements have been satisfied, you can proceed | ||
to set up the database and set up the BDP & DTO. | ||
|
||
.. todo:: Once you are done with the set up, you can have a look at | ||
our :strong:`HelloWorld` example and start the development from | ||
there. |