Skip to content

Commit

Permalink
Merge pull request #177 from noi-techpark/issue-153-links-to-howtos
Browse files Browse the repository at this point in the history 
Issue 153 links to howtos
  • Loading branch information
@bertolla
bertolla committed Oct 27, 2020
2 parents c7a4e16 + 0f81ba0 commit 43dce1f
Show file tree
Hide file tree
Showing 5 changed files with 122 additions and 123 deletions.
44 changes: 13 additions & 31 deletions source/applist.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ makes available.
Applications are grouped according to their status in three categories:

* Production status. These applications are already used in production
environment.
environment.
* Development status, aka `beta stage`, shown by the |beta|
badge. Application in beta stage are developed actively and might
already be suitable for a production environment.
Expand Down Expand Up @@ -77,7 +77,7 @@ Beta Stage Apps
* http://traffic.bz.it/ Some streets in South Tyrol are monitored for
real-time vehicular travel times; the data collected are used by
this web site to show traffic slowdowns or jams.

* http://bus.bz.it/ This web site shows the real-time positions of the
buses managed by the public transport operator SASA. Urban or
suburban bus lines can be shown, and for each bus can be shown the
Expand All @@ -86,7 +86,7 @@ Beta Stage Apps
* https://map.clean-roads.eu/ One of the CLEAN-ROADS project outcomes,
this web site shows real-time data of the meteorological stations
that are situated along public streets.

.. _alpha-stage-apps:

Alpha Stage Apps
Expand All @@ -95,44 +95,26 @@ Alpha Stage Apps
All the projects listed in this section have been built during various
hackathons and must be considered as `Experimental`. |alpha|


.. rubric:: Year 2018

.. panels::
:container: container-lg pb-3
:column: col-sm-4

.. toggle:: Summer Lido Hackathon
.. tabbed:: Summer Lido Hackathon

.. include:: /apps/summerlido2018.rst
.. include:: /apps/summerlido2018.rst

-----

.. toggle:: HackTheAlps

.. include:: /apps/hackthealps2018.rst

-----

.. toggle:: Vertical Innovation Hackathon
.. tabbed:: HackTheAlps

.. include:: /apps/verticalinnovation2018.rst
.. include:: /apps/hackthealps2018.rst

.. tabbed:: Vertical Innovation Hackathon

.. include:: /apps/verticalinnovation2018.rst

.. rubric:: Year 2019

.. panels::
:container: container-lg pb-3
:column: col-sm-6

.. toggle:: NOI Hackathon Summer edition

.. include:: /apps/summerlido2019.rst
.. tabbed:: NOI Hackathon Summer edition

-----
.. include:: /apps/summerlido2019.rst

.. toggle:: NOI Hackathon SFScon Edition
.. tabbed:: NOI Hackathon SFScon Edition

.. include:: /apps/sfscon2019.rst

.. include:: /apps/sfscon2019.rst
70 changes: 45 additions & 25 deletions source/datasets.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ Datasets
========

.. versionadded:: 2020.09 New domain category `Other`, which includes
dataset that do not belong to existing domains.
dataset that do not belong to existing domains

.. versionadded:: 2020.09 New description of domains, new diagrams
that show the datasets encompassed in each domain.
that show the datasets encompassed in each domain

.. versionadded:: 2020.10 Information about licensing of data
contained in the |ODH| responses

.. versionadded:: 2020.10 Links from the dataset lists to the howto section

The goal of the Open Data Hub project is to make available datasets containing
data about the South Tyrolean ecosystem, to allow third parties to
develop novel applications on top of them, consuming the exposed
Expand Down Expand Up @@ -225,7 +227,7 @@ data by using a browser:
interact with the Mobility domain datasets and the description of
the new APIv2 are described in the :ref:`dedicated howto
<get-started-mobility>`.

#. Open the :strong:`Analytics for Mobility` web page, at
https://analytics.opendatahub.bz.it/ This portal uses data in the
mobility domain to display various information about the sensors,
Expand Down Expand Up @@ -374,17 +376,17 @@ team developed and made available.
The description of each dataset includes the following information:

.. csv-table::

"Output", "The output format of the API call"
"E-mail contact", "An e-mail contact for the dataset"
"API version", "The versions of the API that can be used to access
dataset"
dataset"
":literal:`StationType`", "The direct link to each
:literal:`stationType` included in the dataset"
"Use cases and info", "Link to web sites that use the dataset and to
use cases based on the dataset"
"Web component", "Link to Web Components developed on top of the
dataset (optional)"
dataset (optional)"
"Sources", "The list of Data Providers whose data compose the dataset"

.. note:: There is one :literal:`StationType`, namely
Expand All @@ -395,6 +397,13 @@ The description of each dataset includes the following information:
The datasets in the Mobility domain are grouped in :strong:`Traffic`
and :strong:`Mobility` sub-domains as follows:

.. seealso:: The following howto will help you access data in the
Mobility domain:

:doc:`/howto/mobility/getstarted` Access and technical details about the available data

Other howtos are available in the :ref:`dedicated section <howto-list>`.

Traffic
~~~~~~~

Expand All @@ -421,7 +430,7 @@ to plan a trip with an own means of transport, for example a car, or a bike.
.. include:: /datasets/linkstation.rst

.. _parking-dataset:

.. dropdown:: :strong:`it.bz.opendatahub.parking`
:animate: fade-in-slide-down

Expand All @@ -444,7 +453,7 @@ to plan a trip with an own means of transport, for example a car, or a bike.
.. dropdown:: :strong:`it.bz.opendatahub.trafficstation (1)`

.. include:: /datasets/trafficstation.rst

.. _trafficstation-vms-dataset:

.. dropdown:: :strong:`it.bz.opendatahub.trafficstation (2)`
Expand All @@ -468,7 +477,7 @@ for e-cars.
mobility/mobility domain, including new information

.. deprecated:: 2020.10 Public Transportation dataset

.. _bikesharing-dataset:

.. dropdown:: :strong:`it.bz.opendatahub.bikesharing`
Expand Down Expand Up @@ -530,38 +539,50 @@ Interests, and a lot more.
.. versionchanged:: 2020.09 Ordered datasets in alphabetical order

.. versionadded:: 2020.09 Added article, common, venue and eventshort datasets

.. versionchanged:: 2020.10 Changed identifier of datasets activity,
event, gastronomy, package, and POI

.. versionadded:: 2020.10 API URL for all Tourism datasets.

The following information is provided for each dataset in the Tourism domain:

.. csv-table::
"Output", "The output format of the API call"
"E-mail contact", "An e-mail contact for the dataset"

"Output", "The output format of the API call"
"E-mail contact", "An e-mail contact for the dataset"
"API version", "The versions of the API that can be used to access
the dataset"
the dataset"
"Swagger URL", "The URL of the swagger interface to the data"
"API URL", "The URL of the browsable version of the dataset"
"Use cases and info", "Link to web sites that use the dataset and
to use cases based on the dataset"
to use cases based on the dataset"
"Android App", "Link to app for mobile phones developed using the
data in the dataset"
data in the dataset"
"Sources", "The list of Data Providers whose data compose the dataset"


.. seealso:: The following howto will help you access data in the
Tourism domain:

:doc:`/howto/tourism/getstarted` Access and technical details
about the available data

:doc:`/howto/tourism/browse` Browse Open Data offered by the |odh|

:doc:`/howto/tourism/tips` Quick tips and troubleshooting

Other howtos are available in the :ref:`dedicated section <howto-list>`.

.. _package-dataset:

.. dropdown:: :strong:`it.bz.opendatahub.package`

.. include:: /datasets/package.rst

.. _activity-dataset:

.. dropdown:: :strong:`it.bz.opendatahub.activity`

.. include:: /datasets/activity.rst

.. _event-dataset:
Expand All @@ -581,13 +602,13 @@ The following information is provided for each dataset in the Tourism domain:
.. dropdown:: :strong:`it.bz.opendatahub.poi`

.. include:: /datasets/poi.rst

.. _accommodation-dataset:

.. dropdown:: :strong:`it.bz.opendatahub.accommodation`

.. include:: /datasets/accommodation.rst

.. _activity_poi-dataset:

.. dropdown:: :strong:`it.bz.opendatahub.activity_poi`
Expand Down Expand Up @@ -657,10 +678,9 @@ Creative Industries
NOI-Place
~~~~~~~~~
.. include:: /datasets/noiplace.rst

.. _alpinebits-dataset:

https\://alpinebits.opendatahub.bz.it/AlpineBits
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. include:: /datasets/alpinebits.rst

85 changes: 38 additions & 47 deletions source/howto.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,54 +7,45 @@ This page contains the list of available howtos, divided into
areas. The list of howtos, together with a short description is
available here:

.. panels::

.. toggle:: Mobility

#. :doc:`/howto/mobility/getstarted` Getting started with the
new API v2.
#. :doc:`/howto/mobility/mobility`. Since the APIs are very
generic, directions contained in this howto can be applied to
any dataset of the mobility domain.
#. :doc:`/howto/mobility/mobilityanalytics`. This howto guides you in
browse and query data produces from the sensors used in
the mobility domain.

-----
.. tabbed:: Mobility

.. toggle:: Tourism

#. :doc:`/howto/tourism/getstarted` Description of how to
access and manipulate data, the input data used, and the
various filters available in the Tourism domain.
#. :doc:`/howto/tourism/browse` Access to the open data
provided within the Tourism domain.
#. :doc:`/howto/tourism/tips` Mini howtos, tricks&tips, and
use cases for data in the Tourism domain.
#. :doc:`howto/tourism/alpinebits` access AlpineBits data

-----
:column: col-sm-12


.. toggle:: Miscellaneous


#. :doc:`/howto/authentication` Access to data that are not yet open
(mostly for internal use).

#. :doc:`/howto/development` Set up your workstation to
develop for Open Data Hub--This tutorial is still in development
and not so useful at the moment!

#. :doc:`/howto/postman` Setup of Postman, a popular API
development environment, to access data from the Open Data Hub.

#. :doc:`/howto/noievents` Create and modify NOI events
directly from the Open Data Hub portal.

#. :doc:`/howto/webcomponents` share your Web Components with
Open Data Hub team
#. :doc:`/howto/mobility/getstarted` Getting started with the
new API v2.
#. :doc:`/howto/mobility/mobility`. Since the APIs are very
generic, directions contained in this howto can be applied to
any dataset of the mobility domain.
#. :doc:`/howto/mobility/mobilityanalytics`. This howto guides you in
browse and query data produces from the sensors used in
the mobility domain.

.. tabbed:: Tourism

#. :doc:`/howto/tourism/getstarted` Description of how to
access and manipulate data, the input data used, and the
various filters available in the Tourism domain.
#. :doc:`/howto/tourism/browse` Access to the open data
provided within the Tourism domain.
#. :doc:`/howto/tourism/tips` Mini howtos, tricks&tips, and
use cases for data in the Tourism domain.
#. :doc:`howto/tourism/alpinebits` access AlpineBits data

.. tabbed:: Miscellaneous

#. :doc:`/howto/authentication` Access to data that are not yet
open (mostly for internal use).

#. :doc:`/howto/development` Set up your workstation to develop for
Open Data Hub--This tutorial is still in development and not so
useful at the moment!

#. :doc:`/howto/postman` Setup of Postman, a popular API
development environment, to access data from the Open Data Hub.

#. :doc:`/howto/noievents` Create and modify NOI events directly
from the Open Data Hub portal.

#. :doc:`/howto/webcomponents` share your Web Components with Open
Data Hub team


.. toctree::
Expand Down

0 comments on commit 43dce1f

Please sign in to comment.