Skip to content

Commit

Permalink
Merge branch 'master' of github.com:idm-suedtirol/odh-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefano David committed Jul 13, 2018
2 parents 0fd43cf + 18a76d4 commit 8586607
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 1 deletion.
2 changes: 2 additions & 0 deletions source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,5 @@ Data Consumers
Also part of the architecture, but not pictured in the diagram, is the
:file:`persistence.xml` file, which contains the credentials and
postgres configuration used by both the Reader and Writer.

.. include:: dtp.rst
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['replace.rst']
exclude_patterns = ['replace.rst', 'dtp.rst']

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down
33 changes: 33 additions & 0 deletions source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,36 @@ interact with datasets that are not yet part of |odh|.

More details on how you can help shaping the future of |odh| are in
the :ref:`corehacker` page.

.. _bug-reports:

Bug reporting and feature requests
----------------------------------

This section explains what to do in case you:

1. have found an error or a bug in the APIs;
2. like to suggest or require some enhancement for the APIs;
3. have some requests about the datasets
4. find typos or any error in this documentation repository;
5. have an idea for some specific tutorial.


If your feedback is related to the Open Data Hub Core, including
technical bugs or suggestions as well as requests about datasets
(i.e. points 1. to 3. above), please insert your issues on the
following website:

https://github.com/idm-suedtirol/bdp-core/issues

If your feedback is related to the Open Data Hub Documentation,
(i.e. points 4. and 5. above), please insert your issue on the
following website:

https://github.com/idm-suedtirol/odh-docs/issues

.. note:: You need to have a valid github account to report issues and
interact with the |odh| team.

We keep track of your reports in our bug trackers, where you can also
follow progress and comments of the |odh| team members.
35 changes: 35 additions & 0 deletions source/dtp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Development, Testing and, Production Environments
=================================================

.. note:: Information in this section is still provisional!

:numref:`dtp` shows the various environments which compose the whole
|odh| development process.

.. _dtp:

.. figure:: /images/DTP.svg

Diagram showing the development, testing, and production
environments in the |odh| project.


On the right-hand side, the internal structure of development is
shown, while on the left-hand side, how external, and potentially
worldwide collaborators can contribute to and interact with the |odh|
team.

Internally, two distinct and separate environments exist: testing and
production. The former is updated daily, while the latter only when
the expected result (be it a new feature, a bug fix, or anything else)
is ready to be published.

Both environments are updates with Continuous Integration using
Jenkins, which monitors the git repositories and updates the
environemnts.

External developers can push their own code to the git repositories
(provided they have been granted with the permission to do so) and
expect their work to be reviewed and tested by the |odh| team.

.. todo:: Add link to developers resources.
1 change: 1 addition & 0 deletions source/images/DTP.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8586607

Please sign in to comment.