Skip to content

Commit

Permalink
Merge branch 'master' into test-new-theme
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanodavid committed Jun 30, 2023
2 parents 86a2392 + 2d5bfa1 commit 0734d0f
Show file tree
Hide file tree
Showing 19 changed files with 460 additions and 20 deletions.
10 changes: 8 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
<!--
SPDX-FileCopyrightText: NOI Techpark <digital@noi.bz.it>
SPDX-License-Identifier: CC0-1.0
-->

**CONTRIBUTING TO THE ODH DOCUMENTATION PROJECT**

This project takes part of the [Open Data Hub](http://opendatahub.bz.it/).
This project takes part of the [Open Data Hub](http://opendatahub.com/).

If you want to contribute to the [Open Data Hub
Documentation](http://opendatahub.readthedocs.io/en/latest/index.html),
send an email to info@opendatahub.bz.it.
send an email to info@opendatahub.com.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: NOI Techpark <digital@noi.bz.it>
SPDX-License-Identifier: CC0-1.0
-->

---
name: Bug report
about: I found a typo, wrong spelling, or a wrong description
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/feedback.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: NOI Techpark <digital@noi.bz.it>
SPDX-License-Identifier: CC0-1.0
-->

---
name: Feedback
about: Any idea, missing chapter or request
Expand Down
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
repos:
- repo: https://github.com/fsfe/reuse-tool
rev: v1.0.0
hooks:
- id: reuse
17 changes: 17 additions & 0 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: documentation
Upstream-Contact: NOI Techpark <digital@noi.bz.it>
Source: https://github.com/noi-techpark/documentation

Files: make.bat Makefile .pre-commit-config.yaml requirements.txt source/*.rst source/*.txt source/*.sty source/_static/fonts/* source/images/*
Copyright: (c) NOI Techpark <digital@noi.bz.it>
License: CC0-1.0

Files: source/_static/css/bootstrap.min.css
Copyright: (c) 2011-2018 The Bootstrap Authors
(c) 2011-2018 Twitter, Inc.
License: MIT

Files: source/_static/css/odh.css
Copyright: (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors
License: MIT
235 changes: 235 additions & 0 deletions LICENSES/AGPL-3.0-or-later.txt

Large diffs are not rendered by default.

121 changes: 121 additions & 0 deletions LICENSES/CC0-1.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
Creative Commons Legal Code

CC0 1.0 Universal

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
9 changes: 9 additions & 0 deletions LICENSES/MIT.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: NOI Techpark <digital@noi.bz.it>
SPDX-License-Identifier: CC0-1.0
-->

Open Data Hub Documentation
=============================

Expand All @@ -7,7 +13,7 @@ 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
available at https://docs.opendatahub.com/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
Expand Down Expand Up @@ -36,6 +42,21 @@ The documentation consists of two complimentary parts:
**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
help@opendatahub.com. Your feedback or request will be processed
directly by the Customer Care Team and you will likely receive a quick
response!

### REUSE

This project is [REUSE](https://reuse.software) compliant, more information about the usage of REUSE in NOI Techpark repositories can be found [here](https://github.com/noi-techpark/odh-docs/wiki/Guidelines-for-developers-and-licenses#guidelines-for-contributors-and-new-developers).

Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The [pre-commit-config](.pre-commit-config.yaml) file in the repository root is already configured to check for REUSE compliance with help of the [pre-commit](https://pre-commit.com) tool.

Install the tool by running:
```bash
pip install pre-commit
```
Then install the pre-commit hook via the config file by running:
```bash
pre-commit install
```
4 changes: 4 additions & 0 deletions source/_ext/hidemail.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: NOI Techpark <digital@noi.bz.it>
#
# SPDX-License-Identifier: AGPL-3.0-or-later

# E-mail obfuscation role for Sphinx.
#
import sys
Expand Down
6 changes: 6 additions & 0 deletions source/_templates/footer.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: NOI Techpark <digital@noi.bz.it>
SPDX-License-Identifier: CC0-1.0
-->

{% extends '!footer.html' %}

{% block extrafooter %}
Expand Down
12 changes: 8 additions & 4 deletions source/conf.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: NOI Techpark <digital@noi.bz.it>
#
# SPDX-License-Identifier: AGPL-3.0-or-later

# -*- coding: utf-8 -*-
#
# OpenDataHub Docs documentation build configuration file, created by
Expand Down Expand Up @@ -114,9 +118,9 @@
extlinks = { 'sasabus':
('http://sasabus.org/%s', None),
'stinfo':
('https://tourism.api.opendatahub.bz.it/#%s', None),
('https://tourism.api.opendatahub.com/#%s', None),
'apit':
('https://tourism.api.opendatahub.bz.it/v1%s', None),
('https://tourism.api.opendatahub.com/v1%s', None),
'home':
('https://opendatahub.com/datatype/%s', None),
'dataset':
Expand Down Expand Up @@ -241,8 +245,8 @@
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/(.+)'
r'https://tourism.opendatahub.com/token',
r'https://tourism.api.opendatahub.com/(.+)'
]

# -- Options for Texinfo output -------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/guidelines/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.com or send an email to :email:`help@opendatahub.bz.it`.
issues.opendatahub.com or send an email to :email:`help@opendatahub.com`.
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.

Expand Down
2 changes: 1 addition & 1 deletion source/howto/generic/postman.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ below the GET request, then select OAuth 2.0 as the `Type`.

Now, in the right-hand side of the window, write the URL that manages
the tokens (for the tourism domain, this is
https://tourism.opendatahub.bz.it/token and click on the :button:`Get
https://tourism.opendatahub.com/token and click on the :button:`Get
New Access Token` button (:numref:`postman6`).

.. _postman6:
Expand Down
2 changes: 1 addition & 1 deletion source/howto/tourism/browse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Under the header and an informative message, hyperlinks in the centre
of the page allow to open various resources about the Tourism domain.

* The `Swagger interface
<https://tourism.opendatahub.bz.it/swagger/ui/index>`_ of the
<https://tourism.opendatahub.com/swagger/ui/index>`_ of the
datasets, the quickest place from where to access the datasets and
learn how to programmatically retrieve the data

Expand Down
8 changes: 4 additions & 4 deletions source/howto/tourism/tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,22 @@ interface or using an API calls:

* :strong:`reg`:

http://tourism.opendatahub.bz.it/swagger/ui/index#!/Common/Common_GetRegionsReduced
http://tourism.opendatahub.com/swagger/ui/index#!/Common/Common_GetRegionsReduced
:apit:`RegionReduced?language=it`

* :strong:`tvs`:

http://tourism.opendatahub.bz.it/swagger/ui/index#!/Common/Common_GetTourismvereinReduced
http://tourism.opendatahub.com/swagger/ui/index#!/Common/Common_GetTourismvereinReduced
:apit:`TourismAssociationReduced?language=iturismusverein)`

* :strong:`mun`:

http://tourism.opendatahub.bz.it/swagger/ui/index#!/Common/Common_GetMunicipalityReduced
http://tourism.opendatahub.com/swagger/ui/index#!/Common/Common_GetMunicipalityReduced
:apit:`MunicipalityReduced?language=it`

* :strong:`fra`:

http://tourism.opendatahub.bz.it/swagger/ui/index#!/Common/Common_GetDistrictReduced
http://tourism.opendatahub.com/swagger/ui/index#!/Common/Common_GetDistrictReduced
:apit:`DistrictReduced?language=it`

For example, to retrieve all Gastronomy in the suburb of Lana, first
Expand Down
2 changes: 1 addition & 1 deletion source/includes/CLI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ used:
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://tourism.opendatahub.com/swagger/ui/index>`_ or `mobility
<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.
2 changes: 1 addition & 1 deletion source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ available online: they are summarised in the following table.

* :octicon:`triangle-right` The URL of the Swagger
interface is
https://tourism.opendatahub.bz.it/swagger/ui/index
https://tourism.opendatahub.com/swagger/ui/index

* :octicon:`triangle-right` Check out the `Tourism
dedicated howto` (:ref:`tourism-data-howto`) that will
Expand Down
6 changes: 3 additions & 3 deletions source/tourism-tech.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,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
<https://tourism.opendatahub.bz.it/swagger/ui/index>`_ of the API. Some
<https://tourism.opendatahub.com/swagger/ui/index>`_ of the API. Some
examples of their use can be found in section :doc:`/howto/tourism/tips`.

- :strong:`Seed` is used to set pagination. See tip :ref:`TT3
Expand Down Expand Up @@ -178,12 +178,12 @@ The following query will retrieve from the dataset only those item
which have a :strong:`Type` and a strong:`Active` keys defined in the
dataset::

https://tourism.opendatahub.bz.it/api/ODHActivityPoi?fields=Type,Active
https://tourism.opendatahub.com/api/ODHActivityPoi?fields=Type,Active

The following query retrieves information from within a dictionary
field::

https://tourism.opendatahub.bz.it/api/ODHActivityPoi?fields=Detail.en.Title
https://tourism.opendatahub.com/api/ODHActivityPoi?fields=Detail.en.Title

In particular, all items which have a `Title` in `en`\ glish within
the `Detail` will appear in the result set of this query.
Expand Down

0 comments on commit 0734d0f

Please sign in to comment.