Skip to content

Commit

Permalink
Merge pull request #222 from noi-techpark/issue-214-move-content-from…
Browse files Browse the repository at this point in the history
…-howtos

Issue 214 move content from howtos
  • Loading branch information
RudiThoeni committed Jun 1, 2021
2 parents 0cba89f + d46bbb1 commit 72c2e5c
Show file tree
Hide file tree
Showing 17 changed files with 1,121 additions and 1,025 deletions.
3 changes: 0 additions & 3 deletions source/applist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
Apps Built From Open Data Hub Datasets
======================================

.. versionchanged:: 2020.10 Panels layout was replaced with tabs in
the `Alpha Stage` application list.

This section features a list of applications--and their
descriptions--built using the :doc:`datasets` that the Open Data Hub team
makes available.
Expand Down
11 changes: 11 additions & 0 deletions source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Changelog
.. versionadded:: 2021.03 Add extension to provide structured
Changelogs

.. contents:: Available Changelogs:
:local:

This section contains the Changelog of the |odh| project's
documentation.

Expand Down Expand Up @@ -106,3 +109,11 @@ documentation.
* made accessing methods more immediate to see

For more details, please check the reference.

.. change::
:tags: Improvement
:tickets: 214

The technical content of the `getting started` howtos has been
moved to the `Datasets` section, making them
shorter. Also a few examples have been added to :ref:`get-started-mobility`.
46 changes: 20 additions & 26 deletions source/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Datasets
.. versionadded:: 2021.02 |odh| Virtual Knowledge Graph and
description of underlying Knowledge Model

.. versionchanged:: 2021.05 moved technical information for tourism
and mobility to this 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 @@ -35,8 +38,6 @@ section.
Data Providers
--------------

.. versionchanged:: 2020.09 Updated the list of data providers

A :strong:`Data Provider` is any entity that shares their Open Data
with the Open Data Hub project, allowing their free reuse (ideally under a
free licence like |cc0| or |bysa|) from any third-party that relies on
Expand Down Expand Up @@ -184,19 +185,14 @@ are available in section :ref:`authentication-hub`.
Datasets in the Mobility Domain
-------------------------------

.. versionchanged:: 2020.06 Direct link to the browsable version of
the datasets.

.. versionchanged:: 2020.09 Improved description of datasets in the
mobility domain, including external links, use cases, and Data
Providers.
.. toctree::
:hidden:

.. versionchanged:: 2020.09 added dropdowns to the list of datasets to
improve usability

This section contains information about the datasets in the Mobility
Domain and how to access them using the API that the Open Data Hub
team developed and made available.
Technical Information <mobility-tech>

This section contains :ref:`technical information <mobility-tech>`
about the datasets in the Mobility Domain and how to access them using
the API that the Open Data Hub team developed and made available.

.. figure:: /images/Mobility-domain.png
:align: center
Expand Down Expand Up @@ -305,11 +301,6 @@ The Mobility/Mobility sub-domain contains data about public
transportation, sharing of transport means, and recharging stations
for e-cars.

.. versionchanged:: 2020.09 Improved description of datasets in the
mobility/mobility domain, including new information

.. deprecated:: 2020.10 Public Transportation dataset

.. _bikesharing-dataset:

:link-badge:`bikesharing-dataset,it.bz.opendatahub.bikesharing,ref,badge-light`
Expand Down Expand Up @@ -345,9 +336,15 @@ for e-cars.
Datasets in the Tourism Domain
------------------------------

This section contains information about the dataset in the Tourism
Domain and how to access them using the API that the Open Data Hub
team developed and made available.
.. toctree::
:hidden:

Technical Information <tourism-tech>


This section contains :ref:`technical information <tourism-tech>`
about the dataset in the Tourism Domain and how to access them using
the API that the Open Data Hub team developed and made available.

.. figure:: /images/Tourism-domain.png
:align: center
Expand All @@ -360,10 +357,6 @@ find information about winter and summer offers from local touristic
boards, information about weather, hotels and accommodation, Points of
Interests, and a lot more.

.. 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:

Expand Down Expand Up @@ -515,3 +508,4 @@ Datasets in Other Domains
.. odh vkg km
.. include:: /includes/kg.rst

3 changes: 0 additions & 3 deletions source/guidelines/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,6 @@ and :literal:`$TOKEN` is the string of the token.
Authentication To Internal Infrastructure
-----------------------------------------

.. versionchanged:: 2020.10 Authentication to internal infrastructure
does not require :literal:`client_secret` and credentials anyumore

Access to the Open Data Hub's internal infrastructure requires
authentication, which is provided by :strong:`Keycloack`, an Open
Source software that provides Identity and Access Management. In a
Expand Down
9 changes: 3 additions & 6 deletions source/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,9 @@
List of HOWTOs
==============

.. versionchanged:: 2020.10 Panels layout was replaced by tabs in the
howto list.

.. versionchanged:: 2021:04 Replace tabs with (sub-)sections.
.. versionchanged:: 2021:04 Remove howto for API v1.
.. versionchanged:: 2021:04 Resize images in all howtos.
.. versionchanged:: 2021.04 Replace tabs with (sub-)sections.
.. versionchanged:: 2021.04 Remove howto for API v1.
.. versionchanged:: 2021.04 Resize images in all howtos.

This page contains the list of available howtos, divided into
areas. The list of howtos, together with a short description is
Expand Down

0 comments on commit 72c2e5c

Please sign in to comment.