Skip to content

Commit

Permalink
Merge pull request #170 from noi-techpark/issue-158-add-diagrams
Browse files Browse the repository at this point in the history
Issue 158 add diagrams
  • Loading branch information
bertolla committed Oct 15, 2020
2 parents 033d7b7 + 073b892 commit 4e80a90
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 14 deletions.
Binary file added source/images/actors.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 83 additions & 14 deletions source/involved.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,94 @@
Getting Involved
=================

There are different possibilities to participate in the Open Data Hub 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.
.. versionadded:: 2020.10 Rewritten introduction and added description
of possible actors involved in the |odh| and how their possible
interactions with the |odh| project.

.. _odh-actors:

.. figure:: /images/actors.png
:scale: 90%
:align: right

Relations between the actors involved in the |odh|\.

The |odh| team welcomes new partners and user to join the project. For
this reason, a number of services are offered to help you getting in
touch with the project and support you in case you want to either
collaborate with the project or simply use the data made available.


The |odh| team envisioned different possibilities to join the project,
that are detailed in the remainder of this section, including--but not
limited to--reporting bugs in the API or errors in the API output,
making feature requests or suggestions for improvement, and even to
participate in the development or supply new data to be shared through
the |odh|\.

:numref:`odh-actors` shows at a glance the services offered by the
|odh| together with the various roles that potential users can play
within the |odh|\, according to their interest, expertise, skills, and
knowledge.

Data Sharing
The |odh| team helps you in various activities: give
:strong:`visibility` to your data, identify both :strong:`suitable,
common formats`, processing algorithms and licenses to share your
data, and to use popular technologies known by application
developers.

This service is suitable for :ref:`Data Providers
<data-provider-def>`.

Data Access
The |odh| team supports software development companies to
:strong:`access to real-time data`, by making available to everyone
a stable :strong:`communication channel` which uses a
:strong:`machine-readable` protocol and an :strong:`Open Data
license`, to ensure everybody can easily find all the available
data.

This service is most suitable for :ref:`Data Consumers
<data-consumer-def>` and App developers.

Demo App Development
The |odh| team collaborates with companies to design and develop
Proof of Concepts and demo software, released under an :ref:`Open
Source License <odh-license>` that use data offered by the
|odh|\. All the software can then either be used as-is--to show and
test its potentials, or as a guideline and inspiration to develop
new digital products.

This service is suitable for :ref:`Data Consumers
<data-consumer-def>`, App developers, and companies interested in
development built on top of the |odh|\.

Besides the tasks that you find below, you can also help the Open Data
Hub project grow and improve by reporting bugs or asking for new
features, by following the directions presented in :ref:`the dedicated
section below <bug-reports>`.

.. _roles-tasks:

Roles and Tasks
---------------

This section gives an overview of which tasks you can play when
collaborating with the |odh| project.

Depending on your interest on the Open Data Hub Project, we welcome your
participation to the project in one of the roles that we have
envisioned: :strong:`User`, :strong:`App developer`, :strong:`Core
Hacker`, and :strong:`Data Provider`. You can find out below which type of
role better fits with your expertise!
Depending on your interest on the Open Data Hub Project, we welcome
your participation to the project in one of the roles that we have
envisioned: :strong:`User (Data Consumer)`, :strong:`App developer`,
:strong:`Core Hacker`, and :strong:`Data Provider`. Below you can find
out a list of tasks that belong to each of these roles; we believe
that this list can help you understand which type of contribution you
can give to the |odh| project!

You can also help the Open Data Hub project grow and improve by
:ref:`reporting bugs or asking new features <bug-reports>`.

.. panels::

.. toggle:: As a user I can...
.. toggle:: As a User I can...

.. include:: /includes/user.rst

Expand Down Expand Up @@ -50,6 +121,4 @@ Bug reporting and feature requests
----------------------------------

.. include:: /includes/bugrepo.rst



0 comments on commit 4e80a90

Please sign in to comment.