Merge pull request #92 from noi-techpark/issue-90

Issue 90
noi-techpark · Jan 19, 2020 · c824235 · c824235
2 parents eb7376d + dd332e2
commit c824235
Show file tree

Hide file tree

Showing 27 changed files with 75 additions and 56 deletions.
diff --git a/source/applist.rst b/source/applist.rst
@@ -30,7 +30,7 @@ an email contact and its status and we'll add it to the list.
 Production Stage Apps
 ---------------------
 
-* https://www.suedtirol.info.  This portal is the official
+* https://www.suedtirol.info/en This portal is the official
   touristic site of the South Tyrol region. It uses the data extracted
   from the :ref:`tourism-datasets` to display events in the region of
   South Tyrol and other useful information to help tourists organise
@@ -50,7 +50,7 @@ Production Stage Apps
   experiencing South Tyrol, available for both `Android
   <https://play.google.com/store/apps/details?id=com.suedtirol.android>`_
   and `iPhone
-  <https://itunes.apple.com/us/app/s%C3%BCdtirol-mobile-guide/id339011586?mt=8>`_
+  <https://apps.apple.com/us/app/s%C3%BCdtirol-mobile-guide/id339011586>`_
   mobile devices. This app offers all the functionalities of the
   above-mentioned web site, plus the ability to locate events, points
   of interest and the like near your current position.
@@ -60,7 +60,7 @@ Production Stage Apps
 Beta Stage Apps
 ---------------
 
-* https://mobility.meran.eu. This web site is the first example of a
+* https://mobility.meran.eu/ This web site is the first example of a
   Mobility-as-a-Service application; it includes real-time information
   of multiple mobility services, like public transportation, places of
   interests, car sharing services, parking lots, and more in the city
@@ -69,21 +69,21 @@ Beta Stage Apps
 * https://mobility.bz.it/ This web site is the counterpart of the
   previous one for the city of Bolzano/Bozen.
 
-* https://parking.bz.it. A web site that displays the real-time parking
+* https://parking.bz.it/ A web site that displays the real-time parking
   availability of off-street parking lots in South Tyrol. On mobile
   devices, it can also show directions from your current position to
   the chosen parking lot.
 
-* http://traffic.bz.it. Some streets in South Tyrol are monitored for
+* 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
+* 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
   next few stops and an estimate of the arrival time.
 
-* http://map.clean-roads.eu. One of the CLEAN-ROADS project outcomes,
+* 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.
 

diff --git a/source/conf.py b/source/conf.py
@@ -94,6 +94,9 @@
 extlinks = { 'sasabus': ('http://sasabus.org/%s', None),
              'integreen':
              ('http://ipchannels.integreen-life.bz.it/%s', None),
+             'ig-swagger':
+             ('http://ipchannels.integreen-life.bz.it/%s/swagger-ui.html', None),
+
              'stinfo':
              ('http://tourism.opendatahub.bz.it/swagger/ui/index#%s', None),
              'iterconcept': ('https://en.cppreference.com/w/cpp/experimental/ranges/iterator/%s', 'std::'),
@@ -197,6 +200,17 @@
 #
 # man_show_urls = False
 
+# -- Options for linkcheck output -------------------------------------------
+
+linkcheck_anchors = False
+linkcheck_retries = 2
+linkcheck_ignore = [
+    'https://ci.opendatahub.bz.it',
+    'https://github.com/your-username/',
+    'http://localhost:\d+/',
+    'https://cert.provinz.bz.it/musport/services/MuseumsService.MuseumsServiceHttpSoap11Endpoint/',
+    'http://tourism.opendatahub.bz.it/token'
+]
 
 # -- Options for Texinfo output -------------------------------------------
 

diff --git a/source/contributors.rst b/source/contributors.rst
@@ -1,14 +1,15 @@
-GITHUB Quick Documentation for Contributors
-===========================================
+=============================================
+ GITHUB Quick Documentation for Contributors
+=============================================
 
 This section guides you in setting up on your local workstation the
 (forked) git repositories needed to contribute to the |odh| project,
 along with some troubleshooting concerning pull requests and merge
 conflicts. For more detailed help, please refer to the online Github
-help, at https://help.github.com/.
+help, at https://help.github.com/en.
 
 Prerequisites
--------------
+=============
 
 In the following documentation some example names are used. Please
 replace them with your names:
@@ -21,7 +22,7 @@ replace them with your names:
 
 
 Project Checkout
-----------------
+================
 
 Before starting the development, you need to fork the original
 (upstream) repository.
@@ -56,7 +57,7 @@ Before starting the development, you need to fork the original
       Clone the repository.
 
 Create a pull request
----------------------
+=====================
 
 In order to let your contribution be accepted in the |odh| code base,
 you need to follow the following steps.
@@ -119,7 +120,7 @@ you need to follow the following steps.
 .. _syncing-a-fork:
 
 Syncing a Fork
---------------
+==============
 
 Your forked repository does not receive the updates of the original
 repository automatically. To sync for example the
@@ -132,7 +133,8 @@ Before you can sync your fork with the original repository (an
 upstream repository), you must configure a remote that points to the
 upstream repository in Git. A more detailed description for the
 following steps can be found in the online Github help
-https://help.github.com/articles/configuring-a-remote-for-a-fork/.
+https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork
+
 
 1. List the current configured remote repository for your fork.
 
@@ -157,7 +159,7 @@ https://help.github.com/articles/configuring-a-remote-for-a-fork/.
 You need sync a fork of a repository to keep it up-to-date with the
 original repository (upstream repository). A more detailed description
 for the following steps can be found in the online Github help
-https://help.github.com/articles/syncing-a-fork/.
+https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork
 
 1. Fetch the branches and their respective commits from the upstream
    repository. Commits to :strong:`development` will be stored in a
@@ -183,7 +185,7 @@ https://help.github.com/articles/syncing-a-fork/.
       git merge upstream/development
     
 Resolving Merge Conflicts
--------------------------
+=========================
 
 When creating and working on a pull request, it could happen that the
 destination branch of the original repository will change. These
@@ -265,4 +267,5 @@ To resolve merge conflicts, the following steps must be performed.
 
       A solved merge conflict. 
 
-A more detailed description can be found in the online Github help: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/.
+A more detailed description can be found in the online Github help:
+https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.
diff --git a/source/datasets/bikesharing.rst b/source/datasets/bikesharing.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`bikesharing/swagger-ui.html`
+Swagger URL     :ig-swagger:`bikesharing`
 ==============  ========================================================
diff --git a/source/datasets/bluetooth.rst b/source/datasets/bluetooth.rst
@@ -12,5 +12,5 @@ board of vehicle that drive on.
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`BluetoothFrontEnd`
+Swagger URL     :ig-swagger:`BluetoothFrontEnd`
 ==============  ========================================================
diff --git a/source/datasets/carpoolinghub.rst b/source/datasets/carpoolinghub.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`carpooling/swagger-ui.html`
+Swagger URL     :ig-swagger:`carpooling`
 ==============  ========================================================
diff --git a/source/datasets/carsharing.rst b/source/datasets/carsharing.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`carsharing/swagger-ui.html`
+Swagger URL     :ig-swagger:`carsharing`
 ==============  ========================================================
diff --git a/source/datasets/ecs.rst b/source/datasets/ecs.rst
@@ -6,5 +6,5 @@ South Tyrol and their status, including historical data and usage.
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`EchargingFrontEnd`
+Swagger URL     :ig-swagger:`EchargingFrontEnd`
 ==============  ========================================================
diff --git a/source/datasets/environment.rst b/source/datasets/environment.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`environment/swagger-ui.html`
+Swagger URL     :ig-swagger:`environment`
 ==============  ========================================================
diff --git a/source/datasets/linkstation.rst b/source/datasets/linkstation.rst
@@ -10,5 +10,5 @@ measure the level of traffic on the strech of a road.
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`LinkFrontEnd`
+Swagger URL     :ig-swagger:`LinkFrontEnd`
 ==============  ========================================================
diff --git a/source/datasets/parking.rst b/source/datasets/parking.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`parking/swagger-ui.html`
+Swagger URL     :ig-swagger:`parking`
 ==============  ========================================================
diff --git a/source/datasets/rwisstation.rst b/source/datasets/rwisstation.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`roadweather/swagger-ui.html`
+Swagger URL     :ig-swagger:`roadweather`
 ==============  ========================================================
diff --git a/source/datasets/streetelements.rst b/source/datasets/streetelements.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`street/swagger-ui.html`
+Swagger URL     :ig-swagger:`street`
 ==============  ========================================================
diff --git a/source/datasets/trafficstation.rst b/source/datasets/trafficstation.rst
@@ -6,5 +6,5 @@
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`sensors/swagger-ui.html`
+Swagger URL     :ig-swagger:`sensors`
 ==============  ========================================================
diff --git a/source/datasets/weather.rst b/source/datasets/weather.rst
@@ -9,5 +9,5 @@ hydrographical Department of South Tyrol.
 Output          JSON, mime-type application/json
 E-mail contact  |contact|
 API version     v1
-Swagger URL     :integreen:`meteorology`
+Swagger URL     :ig-swagger:`meteorology`
 ==============  ========================================================
diff --git a/source/guidelines/database.rst b/source/guidelines/database.rst
@@ -5,7 +5,8 @@ Database Guidelines - Full Version
 
 .. topic:: Changelog
 
-   * :strong:`2018-05-28 version 1.0`
+   * :strong:`2020-01-20 version 1.1` -- fixed outgoing links
+   * 2018-05-28 version 1.0
 
 +++++
 
@@ -46,7 +47,7 @@ Specifically, the following methodologies are well known and acceptable:
    :command:`CREATE` statements are written by the developer.  The
    JSON data column must use the PostgreSQL native data type
    :strong:`jsonb` (see `binary stored JSON
-   <https://www.postgresql.org/docs/10/static/datatype-json.html#JSON-DOC-DESIGN>`_
+   <https://www.postgresql.org/docs/10/datatype-json.html#JSON-DOC-DESIGN>`_
    in PostgreSQL documentation).
 
 PostgreSQL supports all three methodologies well. It is also possible
@@ -150,7 +151,7 @@ Contributors can expect their database design to be stored into a
 schema whose name is determined by the |odh| team and executed as a
 non-privileged user account that has the given schema in its default
 :strong:`search_path` (see `DDL schema path
-<https://www.postgresql.org/docs/10/static/ddl-schemas.html#DDL-SCHEMAS-PATH>`_
+<https://www.postgresql.org/docs/10/ddl-schemas.html#DDL-SCHEMAS-PATH>`_
 in PostgreSQL documentation).
 
 Unless there is a specific reason, contributed designs must use
@@ -181,15 +182,15 @@ Hence, the general rule is that database designs submitted to the
 However, (small) utility procedures and functions, especially with
 respect to triggers, are allowed. When used, these procedures and
 functions must be written in `PL/PgSQL
-<https://www.postgresql.org/docs/10/static/plpgsql.html>`_. Other
+<https://www.postgresql.org/docs/10/plpgsql.html>`_. Other
 server-side languages, even the trusted ones, are neither allowed, nor
 can they be expected to be available.
 
 An example of such an allowed instance of a procedure is an audit
 trigger that, for any changes made to :strong:`Table A` generates a
 log entry that is stored in :strong:`Table B`.
 
-Foreign data wrappers (`SQL/MED <https://www.postgresql.org/docs/10/static/sql-createforeigndatawrapper.html>`_) :strong:`must not` be used.
+Foreign data wrappers (`SQL/MED <https://www.postgresql.org/docs/10/sql-createforeigndatawrapper.html>`_) :strong:`must not` be used.
 
 Indices and Partioning
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -207,7 +208,7 @@ columns will benefit from indices, when the number of records grows.
 In particular, if methodology 3 (JSON) is chosen, PostgreSQL provides
 specialized multi-dimensional indices of type GIN to index the `jsonb
 data type
-<https://www.postgresql.org/docs/10/static/datatype-json.html#JSON-INDEXING>`_.
+<https://www.postgresql.org/docs/10/datatype-json.html#JSON-INDEXING>`_.
 
 If the contributor anticipates designs with large tables (say more
 than 100M records or more than 5 GB on disk) and expects queries
@@ -243,7 +244,7 @@ and Italian::
 A contributor is free to add a custom collation such as
 :envvar:`de_DE` or :envvar:`it_IT`, either at the DDL level or the
 query level (see `PostgreSQL documentation on collation
-<https://www.postgresql.org/docs/10/static/collation.html>`_),
+<https://www.postgresql.org/docs/10/collation.html>`_),
 although there is most likely no need to apply other collations.
 
 
@@ -310,7 +311,7 @@ Sometimes developers need to convert to and from text. In case a
 contributing developer wishes to do this using PostgreSQL functions,
 they must use functions :strong:`to_date()` and :strong:`to_char()`
 (see `PostgreSQL documentation on function formatting
-<https://www.postgresql.org/docs/10/static/functions-formatting.html>`_).
+<https://www.postgresql.org/docs/10/functions-formatting.html>`_).
 
 For example:
 

diff --git a/source/guidelines/introduction.rst b/source/guidelines/introduction.rst
@@ -4,7 +4,7 @@ Guidelines for Developers
 =========================
 
 |odh| is a collection of software, databases, and services coordinated
-and hosted by `NOI techpark <https://noi.bz.it/>`_ in Bolzano/Bozen,
+and hosted by `NOI techpark <https://noi.bz.it/en>`_ in Bolzano/Bozen,
 South Tyrol. Currently, |odh| systems are related to mobility and
 tourism. In the future |odh| might diversify into more fields.
 

diff --git a/source/guidelines/platform.rst b/source/guidelines/platform.rst
@@ -6,8 +6,9 @@ Platform Guidelines - Full Version
 
 
 .. topic:: Changelog
-
-   * :strong:`2018-05-28 version 1.0`
+
+   * :strong:`2020-01-20 version 1.1` -- fixed outgoing links
+   * 2018-05-28 version 1.0
    * 2018-03-30 version 1.0-beta
 
 +++++

diff --git a/source/howto/mobility.rst b/source/howto/mobility.rst
@@ -25,7 +25,7 @@ The API calls shown here can be used with other datasets of the
 :ref:`mobility domain <mobility-datasets>`.
 
 You can find all the API's defined methods and documentation at the
-URL :integreen:`EchargingFrontEnd`.
+URL :ig-swagger:`EchargingFrontEnd`.
 
 The two most basic REST calls are carried out by the methods
 :command:`get-stations` and  :command:`get-station-details`.

diff --git a/source/howto/postman.rst b/source/howto/postman.rst
@@ -14,7 +14,7 @@ In the remainder of this tutorial, we will use as example the
 http://ipchannels.integreen-life.bz.it/emobility/swagger-ui.html for
 the mobility domain and the :ref:`Accommodation
 <accommodation-dataset>` dataset, located at
-http://tourism.opendatahub.bz.it/swagger/ui/index#/Accommodation.
+:stinfo:`Accommodation`.
 
 
 Initial Setup

diff --git a/source/howto/tourism/access.rst b/source/howto/tourism/access.rst
@@ -6,7 +6,7 @@ Data Access and Manipulation
 
 All the APIs available for the tourism domain can be accessed from the
 same URL through their Swagger user interface:
-http::/tourism.opendatahub.bz.it/swagger
+http://tourism.opendatahub.bz.it/swagger/ui/index
 
 .. versionchanged:: 2019-May new and easier procedure to authenticate
    and to store credentials.

diff --git a/source/howto/tourism/browse.rst b/source/howto/tourism/browse.rst
@@ -22,7 +22,7 @@ and point it to http://tourism.opendatahub.bz.it/.
 
 Under the header and an informative message, two icons and hyperlink
 in the centre of the page allow to reach the `Swagger interface
-<http://tourism.opendatahub.bz.it/swagger>`_, the quickest place from
+<http://tourism.opendatahub.bz.it/swagger/ui/index>`_, the quickest place from
 where to access the datasets and learn how to programmatically
 retrieve the data, and the `Official documentation
 <https://opendatahub.readthedocs.io/en/latest/index.html>`_.

diff --git a/source/howto/tourism/getstarted.rst b/source/howto/tourism/getstarted.rst
@@ -61,7 +61,7 @@ Filters are used within a dataset and their primary purpose is to
 limit the result set according to specific parameters, although they
 might not be available in every API call. Information about default
 values can be found for each datasets in the `swagger interface
-<http::/tourism.opendatahub.bz.it/swagger>`_ of the API. Some examples
+<http://tourism.opendatahub.bz.it/swagger/ui/index>`_ of the API. Some examples
 of their use can be found in section :doc:`tips`.
 
 - :strong:`Seed` is used to set pagination. See tip :ref:`TT3

diff --git a/source/includes/bugrepo.rst b/source/includes/bugrepo.rst
@@ -19,8 +19,8 @@ If your feedback is related to the Open Data Hub Documentation, please
 insert your issue on the following website, using the template that
 suits your needs:
 
-4. https://github.com/noi-techpark/odh-docs/issues/new?template=bug_report.md
-5. https://github.com/noi-techpark/odh-docs/issues/new?template=feedback.md
+4. `Report a bug <https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fnoi-techpark%2Fodh-docs%2Fissues%2Fnew%3Ftemplate%3Dbug_report.md>`_
+5. `Leave your feedback <https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fnoi-techpark%2Fodh-docs%2Fissues%2Fnew%3Ftemplate%3Dfeedback.md>`_
 
 .. note:: You need to have a valid github account to report issues and
    interact with the |odh| team.