Merge pull request #274 from noi-techpark/issue-262-domain-change

Issue 262 domain change
noi-techpark · Jan 13, 2023 · aec66ab · aec66ab
2 parents d0556b5 + 5d42b45
commit aec66ab
Show file tree

Hide file tree

Showing 34 changed files with 85 additions and 71 deletions.
diff --git a/source/appendices.rst b/source/appendices.rst
@@ -3,7 +3,6 @@
 Appendices
 ==========
 
-.. versionchanged:: 2022.03 Moved |odh| Architecture in the appendices.
 
 The following is the list of appendices.
 

diff --git a/source/changelogs/2023.rst b/source/changelogs/2023.rst
@@ -0,0 +1,21 @@
+================
+ Changelog 2023
+================
+
+.. changelog::
+   :version: 2023.01
+   :released: 31 January 2023
+
+   .. change::
+      :tags: Changes
+      :tickets: 262
+
+      Replace |odh| domains from ``.bz.it`` to ``.com``.
+
+   .. change::
+      :tags: Changes
+      :tickets: 269
+
+      Update outdated links, and fix ``linkcheck`` builder's
+      configuration.
+
diff --git a/source/conf.py b/source/conf.py
@@ -14,7 +14,7 @@
 
 current_year = time.strftime('%Y')
 sys.path.append(os.path.abspath("./_ext"))
-contact_mail = 'help@opendatahub.bz.it'
+contact_mail = 'help@opendatahub.com'
 
 # -- General configuration ------------------------------------------------
 
@@ -84,7 +84,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -237,11 +237,13 @@
 linkcheck_anchors = False
 linkcheck_retries = 2
 linkcheck_ignore = [
-    'https://ci.opendatahub.bz.it',
-    'https://github.com/$USERNAME/',
-    'https://localhost:\d+/',
-    'https://cert.provinz.bz.it/musport/services/MuseumsService.MuseumsServiceHttpSoap11Endpoint/',
-    'http://tourism.opendatahub.bz.it/token',
+    r'https://ci.opendatahub.com',
+    r'https://github.com/\$USERNAME/(.+)',
+    r'https://alpinebits.opendatahub.com/AlpineBits',
+    r'https://localhost:\d+/',
+    r'https://cert.provinz.bz.it/musport/services/MuseumsService.MuseumsServiceHttpSoap11Endpoint/',
+    r'https://tourism.opendatahub.bz.it/token',
+    r'https://tourism.api.opendatahub.bz.it/(.+)'
 ]
 
 # -- Options for Texinfo output -------------------------------------------

diff --git a/source/datasets.rst b/source/datasets.rst
@@ -3,8 +3,6 @@
 Domains and Datasets
 ====================
 
-.. versionchanged:: 2022.03 Move Domain description in this section
-
 .. topic:: What is a Domain?
 
    .. include:: /includes/domains.rst

diff --git a/source/guidelines.rst b/source/guidelines.rst
@@ -4,7 +4,6 @@
 Documentation for Developers
 ============================
 
-.. versionchanged:: 2022.05 Section renamed
 
 This section contains all information that is necessary to
 developers that want to collaborate with the |odh| team (e.g.,

diff --git a/source/guidelines/authentication.rst b/source/guidelines/authentication.rst
@@ -88,7 +88,7 @@ is the method shown here.
 
 In order to receive an access token, you need in advance to have credentials for
 the Open Data Hub. If you do not have them, please open a ticket on
-issues.opendatahub.bz.it or send an email to :email:`help@opendatahub.bz.it`.
+issues.opendatahub.com or send an email to :email:`help@opendatahub.bz.it`.
 The same holds, if you plan to create an application that retrieves closed data
 from the Open Data Hub. For this, also other OAuth2 flows exist.
 
@@ -100,7 +100,7 @@ to you with the following call:
    :name: grant-token
    :caption: Receiving an access topic
 
-   ~$ curl -X POST -L "https://auth.opendatahub.bz.it/auth/realms/noi/protocol/openid-connect/token" \
+   ~$ curl -X POST -L "https://auth.opendatahub.com/auth/realms/noi/protocol/openid-connect/token" \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'grant_type=password' \
    --data-urlencode 'username=my_username' \
@@ -116,7 +116,7 @@ parameters given in the query above with
    :name: refresh-token
    :caption: Refreshing the access token
 
-   ~$ curl -X POST -L "https://auth.opendatahub.bz.it/auth/realms/noi/protocol/openid-connect/token" \
+   ~$ curl -X POST -L "https://auth.opendatahub.com/auth/realms/noi/protocol/openid-connect/token" \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'grant_type=refresh_token' \
    --data-urlencode 'refresh_token=the_refresh_token' \
@@ -136,7 +136,7 @@ requests. The following API call shows how to get all
    :name: get-closed-data
    :caption: Retrieving data with the access token
 
-   ~$ curl -X GET "https://mobility.api.opendatahub.bz.it/v2/flat/VMS/*/latest?select=sname,mvalue" \
+   ~$ curl -X GET "https://mobility.api.opendatahub.com/v2/flat/VMS/*/latest?select=sname,mvalue" \
    --header 'Content-Type: application/json' \
    --header 'Authorization: bearer your-access-token'
 

diff --git a/source/guidelines/database.rst b/source/guidelines/database.rst
@@ -3,7 +3,6 @@
 Database Documentation
 ----------------------
 
-.. versionchanged:: 2022.05 Integrate summaries
 
 .. topic:: Changelog
 

diff --git a/source/guidelines/introduction.rst b/source/guidelines/introduction.rst
@@ -3,7 +3,6 @@
 Guidelines for Developers
 =========================
 
-.. versionchanged:: 22.05 Move summaries before their respective full
    versions
 
 |odh| is a collection of software, databases, and services coordinated

diff --git a/source/guidelines/platform.rst b/source/guidelines/platform.rst
@@ -4,7 +4,6 @@
 Platform Documentation
 ----------------------
 
-.. versionchanged:: 2022.05 Integrate summaries
 
 .. topic:: Changelog
 
@@ -104,8 +103,8 @@ The chosen programing language for |odh| is Java, more precisely the Java
 Platform, Standard Edition (Java SE).
 
 Source code will be compiled with either the `OpenJDK
-<https://openjdk.java.net/>`_ or the `OracleJDK
-<https://www.oracle.com/java/technologies/javase-downloads.html>`_,
+<https://openjdk.org/>`_ or the `OracleJDK
+<https://www.oracle.com/java/technologies/downloads>`_,
 which share the same code base anyway. Resulting binaries will run in
 the corresponding JVM.
 

diff --git a/source/howto/generic/contributors.rst b/source/howto/generic/contributors.rst
@@ -2,7 +2,6 @@
  GITHUB Quick Howto
 ====================
 
-.. versionchanged:: 2022.05 moved from section :ref:`devels-resources`
 
 This howto guides you in setting up on your local workstation the
 (forked) ``git`` repositories needed to contribute to the |odh| project,
@@ -133,7 +132,7 @@ you need to follow the following steps.
       Show outcome of a pull request.
 
 8. In addition, the detailed logs can be viewed under
-   https://ci.opendatahub.bz.it.
+   https://ci.opendatahub.com.
 
 .. _syncing-a-fork:
 
@@ -151,7 +150,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://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork>`_.
+<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork>`_.
+
 
 1. List the current configured remote repository for your fork.
 
@@ -174,7 +174,7 @@ following steps can be found in the `online Github help
 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://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.
+`<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork>`_.
 
 1. Fetch the branches and their respective commits from the upstream
    repository. Commits to :strong:`development` will be stored in a

diff --git a/source/howto/generic/noievents.rst b/source/howto/generic/noievents.rst
@@ -16,7 +16,7 @@ Since you must login to create events, you need valid credentials to
 be able to add NOI events, that you should have received from the
 |odh| team.
 
-Go to https://databrowser.opendatahub.bz.it and click on Log in (top
+Go to https://databrowser.opendatahub.com and click on Log in (top
 right corner)
 
 .. figure:: /images/events/login.png

diff --git a/source/howto/generic/postman.rst b/source/howto/generic/postman.rst
@@ -12,7 +12,7 @@ mobility and tourism domains.
 In the remainder of this tutorial, we will use as example the
 :dataset:`E-charging station <mobility/echargingstation/>` dataset,
 located at
-https://swagger.opendatahub.bz.it/?url=https://mobility.api.opendatahub.bz.it/v2/apispec#/Mobility%20V1%20-%20Emobility/
+https://swagger.opendatahub.com/?url=https://mobility.api.opendatahub.com/v2/apispec#/Mobility%20V1%20-%20Emobility/
 for the mobility domain and the :dataset:`Accommodations
 <tourism/accommodation_one/>` dataset, located at
 :stinfo:`Accommodation`.

diff --git a/source/howto/generic/r-howto.rst b/source/howto/generic/r-howto.rst
@@ -58,16 +58,17 @@ well as the required R's `SPARQL library
      2: In install.packages("SPARQL") :
        installation of package ‘SPARQL’ had non-zero exit status
 
-   Documentation for the library can be found in the library's `PDF
-   documentation
-   <https://cran.mirror.garr.it/CRAN/web/packages/SPARQL/SPARQL.pdf>`_
+   ..
+      Documentation for the library can be found in the library's `PDF
+      documentation
+      <https://cran.mirror.garr.it/CRAN/web/packages/SPARQL/SPARQL.pdf>`_
 
 In order to fetch data, you need:
 
-1. An endpoint, which for |odh| is https://sparql.opendatahub.bz.it/sparql
+1. An endpoint, which for |odh| is https://sparql.opendatahub.com/sparql
 
 2. a SPARQL query, that you can simply copy from one of the precooked
-   queries at https://sparql.opendatahub.bz.it/ We'll be using this
+   queries at https://sparql.opendatahub.com/ We'll be using this
    one:
 
    .. code:: sparql
@@ -94,7 +95,7 @@ In order to fetch data, you need:
       
       library(SPARQL)
 
-      endpoint <- "https://sparql.opendatahub.bz.it/sparql"
+      endpoint <- "https://sparql.opendatahub.com/sparql"
 
       query <- 
       'PREFIX schema: <https://schema.org/>
@@ -176,7 +177,7 @@ install it on a Debian-like system, use as `root` the following command::
 
 If you execute a query and the outcome is not a result set but some
 error message similar to the following ones, please verify that the
-URL of the SPARQL endpoint is correct: :strong:`https\://sparql.opendatahub.bz.it/sparql`
+URL of the SPARQL endpoint is correct: :strong:`https\://sparql.opendatahub.com/sparql`
 
 ::
    

diff --git a/source/howto/generic/sparql-endpoint.rst b/source/howto/generic/sparql-endpoint.rst
@@ -5,7 +5,7 @@ How to Access |odh| Data Using SPARQL
 
 The |odh|\'s dataset can be queried using the SPARQL query language,
 using the `Open Data Hub Knowledge Graph Portal
-<https://sparql.opendatahub.bz.it/>`_. This howto helps you in getting
+<https://sparql.opendatahub.com/>`_. This howto helps you in getting
 acquainted with the functionalities offered by the endpoint. However,
 this howto does not cover SPARQL: if you are not familiar with it,
 here is some reference:

diff --git a/source/howto/mobility/getstarted.rst b/source/howto/mobility/getstarted.rst
@@ -12,7 +12,7 @@ The starting point for all actions to be carried out on the datasets
 made available by the Open Data Hub team is the swagger mobility API
 home page:
 
-https://mobility.api.opendatahub.bz.it/
+https://swagger.opendatahub.com/?url=https://mobility.api.opendatahub.com/v2/apispec
 
 .. figure:: /images/mobility-swagger.png
    :scale: 33%

diff --git a/source/howto/mobility/mobilityanalytics.rst b/source/howto/mobility/mobilityanalytics.rst
@@ -4,7 +4,7 @@ How to Access Analytics Data in the Mobility Domain
 ===================================================
 
 This howto guides you in browsing and querying data from the Mobility
-domain using the https://analytics.opendatahub.bz.it/ web site.
+domain using the https://analytics.opendatahub.com/ web site.
 
 .. note:: Access to data on this website is now possible by
    using R. See :ref:`the dedicated section <r-access>`  for
@@ -14,7 +14,7 @@ domain using the https://analytics.opendatahub.bz.it/ web site.
 Introduction
 ------------
 
-The website https://analytics.opendatahub.bz.it/ gathers data from
+The website https://analytics.opendatahub.com/ gathers data from
 datasets in the mobility domain and uses them to draw two types of
 diagram: a :ref:`chart <charts>` using historical data and an
 interactive :ref:`map <mapoverview>` that show where are located the

diff --git a/source/howto/tourism/alpinebits.rst b/source/howto/tourism/alpinebits.rst
@@ -5,7 +5,7 @@ How to access Open Data Hub AlpineBits Server as a client
 
 In this howto, we show how to retrieve data from the AlpineBits Server
 endpoint for the Open Data Hub located at
-https://alpinebits.opendatahub.bz.it/AlpineBits, by using the (Linux)
+https://alpinebits.opendatahub.com/AlpineBits, by using the (Linux)
 command line--in particular the :command:`curl` application, and the
 popular `Postman` API development environment.  An example call can be
 seen :ref:`at the bottom <ab-request>` of this section.
@@ -73,7 +73,7 @@ looks like the following one:
 .. code-block:: 
 		
    ~# curl --location --request POST \
-   'https://alpinebits.opendatahub.bz.it/AlpineBits' \
+   'https://alpinebits.opendatahub.com/AlpineBits' \
    --header 'Authorization: Basic <your-token-here>' \
    --header 'X-AlpineBits-ClientProtocolVersion: 2017-10' \
    --header 'X-AlpineBits-ClientID: 'My test request' \

diff --git a/source/howto/tourism/browse.rst b/source/howto/tourism/browse.rst
@@ -12,7 +12,7 @@ Data Browsing and Exploring
 ---------------------------
 
 In order to access the data in the tourism domain, launch a browser
-and point it to https://databrowser.opendatahub.bz.it/.
+and point it to https://databrowser.opendatahub.com/.
 
 .. _tourism-login-web:
 

diff --git a/source/howto/tourism/getstarted.rst b/source/howto/tourism/getstarted.rst
@@ -14,7 +14,7 @@ Swagger Interface
 All the APIs available for the tourism domain can be accessed from the
 same URL through their Swagger user interface:
 
-https://tourism.api.opendatahub.bz.it/swagger/index.html
+https://tourism.api.opendatahub.com/swagger/index.html
 
 .. hint:: Check section :ref:`tourism-datasets` for direct URLs to the
    datasets.
@@ -78,7 +78,7 @@ Browsing API Datasets
 
 The data in the API can be browsed at the following URL:
 
-https://tourism.api.opendatahub.bz.it/v1/
+https://tourism.api.opendatahub.com/v1/
 
 .. note:: You may need to install a `JSON browser plugin` for your
    browser to browse the datasets in this way.
@@ -113,7 +113,7 @@ add an authentication header to each call. For example, using curl:
 
    ~# curl -X GET --header 'Accept: application/json' \
    --header 'Authorization: Bearer vLwemAqrLKVKXsvgvEQgtkeanbMq7Xcs' \
-   'https://tourism.api.opendatahub.bz.it/v1/Gastronomy'
+   'https://tourism.api.opendatahub.com/v1/Gastronomy'
 
 .. note:: The string of the token is shortened for the sake of
    clarity. 

diff --git a/source/includes/AlpineBits.rst b/source/includes/AlpineBits.rst
@@ -34,7 +34,7 @@ Data specs` (`pdf
 
 The :strong:`reference implementation` of AlpineBits DestinationData
 is provided by |odh| and publicly available at the dedicated endpoint at
-https://destinationdata.alpinebits.opendatahub.bz.it/.
+https://destinationdata.alpinebits.opendatahub.com/.
 
 .. seealso:: More information and resources about AlpineBits
    DestinationData can be found on the `official page
@@ -49,7 +49,7 @@ The `AlpineBits HotelData <https://www.alpinebits.org/hoteldata/>`_ is
 meant for data strictly related to hotels and booking, like Inventory
 Basic, Inventory HotelInfo, and FreeRooms. This dataset can be access
 from the dedicated endpoint at
-https://alpinebits.opendatahub.bz.it/AlpineBits/
+https://alpinebits.opendatahub.com/AlpineBits/
 
 .. seealso::
 

diff --git a/source/includes/CLI.rst b/source/includes/CLI.rst
@@ -25,12 +25,12 @@ used:
 
 .. code-block:: bash
 		
-   ~$ curl -X GET "https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?pagenumber=1&pagesize=10&type=63&subtype=null&poitype=null&idlist=null&locfilter=null&langfilter=null&areafilter=null&highlight=null&source=null&odhtagfilter=null&odhactive=null&active=null&seed=null&latitude=null&longitude=null&radius=null" -H "accept: application/json"
+   ~$ curl -X GET "https://tourism.api.opendatahub.com/v1/ODHActivityPoi?pagenumber=1&pagesize=10&type=63&subtype=null&poitype=null&idlist=null&locfilter=null&langfilter=null&areafilter=null&highlight=null&source=null&odhtagfilter=null&odhactive=null&active=null&seed=null&latitude=null&longitude=null&radius=null" -H "accept: application/json"
 
 
 Your best opportunity to learn about the correct syntax and parameters
 to use is to go to the :strong:`swagger interface` of the `tourism
 <https://tourism.opendatahub.bz.it/swagger/ui/index>`_ or `mobility
-<https://mobility.api.opendatahub.bz.it/>`_ domains and execute a
+<https://mobility.api.opendatahub.com/>`_ domains and execute a
 query: with the output, also the corresponding :program:`curl` command
 used to retrieve the data will be shown.
diff --git a/source/includes/R.rst b/source/includes/R.rst
@@ -4,7 +4,7 @@ analysis that creates also graphics from the gathered data.
 The Open Data Hub Team has developed and made available `bzar
 <https://github.com/noi-techpark/it.bz.opendatahub.analytics.libs/tree/main/api/R>`_,
 an R package that can be used to access `BZ Analytics
-<https://analytics.opendatahub.bz.it/>`_ data (see also
+<https://analytics.opendatahub.com/>`_ data (see also
 :ref:`bz-analytics`) and process them using all the R
 capabilities. Download and installation instructions, along with
 example usage can be found on the `bzar repository

diff --git a/source/includes/ab-short.rst b/source/includes/ab-short.rst
@@ -4,9 +4,9 @@ format to exchange tourism data. |odh| allows access to all data
 produced by AlpineBits using dedicated endpoints:
 
 The :ref:`AlpineBits HotelData <ab-hd>` dataset can be access from
-https://alpinebits.opendatahub.bz.it/AlpineBits/.
+https://alpinebits.opendatahub.com/AlpineBits/.
 
 .. seealso:: The dedicated howto :ref:`ab-howto`
 
 The :ref:`AlpineBits DestinationData <ab-dd>` endpoint is available at
-https://destinationdata.alpinebits.opendatahub.bz.it/.
+https://destinationdata.alpinebits.opendatahub.com/.