Skip to content

Commit

Permalink
new README format
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanodavid committed Feb 15, 2021
1 parent d1d6b62 commit d88df35
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
=============================
Open Data Hub Documentation
=============================

This repository contains documentation about the Open Data Hub
project.

The documentation consists of two complimentary parts:

1. The 'stable' documentation, that does not change much over time,
available at https://docs.opendatahub.bz.it/en/latest/. This
documentation can be accessed by anyone to have an overview of the
Open Data Hub and to discover if the project can interest them or
if they can join or interact with the Team. In more details, this
part contains:

* An introduction about the project and its architecture, purpose,
and the data available
* A list of possibilities to collaborate with the Open Data Hub
Team
* Description of all the datasets included in the Open Data Hub
* How-tos for interacting with the data and the available datasets
* More detailed technical insights on the project
* Various additional information

2. A wiki, containing more 'volatile' information, that may change
over time and is intended for DevOps and developers to quickly find
'ready-to-use' information, like for example more detailed
information about datasets, data records, API, FAQ, and
troubleshooting.

The wiki is included in this repository and can be freely accessed
by anyone at https://github.com/noi-techpark/odh-docs/wiki/

*****

**Note:** If you experience any issue when using the APIs (like e.g.,
endpoints down or throwing errors, query outcome not meeting the
expected result), please send an email directly to
help@opendatahub.bz.it. Your feedback or request will be processed
directly by the Customer Care Team and you will likely receive a quick
response!

0 comments on commit d88df35

Please sign in to comment.