Skip to content

Commit

Permalink
add Web Components and improve descriptions of other tools
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanodavid authored and Peter Moser committed Mar 15, 2022
1 parent 581eaf5 commit 84ef180
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 37 deletions.
14 changes: 5 additions & 9 deletions source/howto/generic/webcomponents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,12 @@
How to Publish your Web Component on the |ODH| Store
====================================================

If you have developed a :term:`Web Component` that you deem useful for
the |odh| project or that can be used on top of data provided by the
|odh|, you can share it and allow other to reuse it, by making it
freely available on |odh|\'s `Web Components Store
<https://webcomponents.opendatahub.bz.it/>`_.
This how to guides you in the process of making available a Web
Component that you created with the |odh| Community, by publishing it
on |odh| Store.

The only requirement for all the Web Components offered through the
Store is that they :strong:`must` be released as an :ref:`Open Source
Licence <odh-license>`, compatible with those used within the |odh|
project.
The only requirement is that the Web Component :strong:`must` be
released as an :ref:`Open Source Licence <odh-license>`.

One of three alternatives can be chosen to publish a Web Component on
the Store: as a :strong:`full open source` project, as a
Expand Down
91 changes: 63 additions & 28 deletions source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,31 @@ This section helps you in getting quickly in touch with the most
popular tools developed by |odh| to interact with the dataset and
the whole ecosystem.

At the time of writing, all tools are available online: they are
summarised in the following table.
At the time of writing, all tools that have been developed are
available online: they are summarised in the following table.

.. grid::
:gutter: 3

.. grid-item-card::
:columns: 6

Databrowser
Data Browser
^^^^^

Access the `ODH Tourism data browser
<https://databrowser.opendatahub.bz.it/>`_ and search for the
Open Data available in the Tourism domain. You can simply use
those data for your convenience, or you might even find a novel
way to exploit those data and use them in an app or portal you
are going to develop. A detailed howto is available:
:ref:`tourism-data-browser-howto` to help you getting acquainted
with the browser.
The `ODH Tourism Data Browser
<https://databrowser.opendatahub.bz.it/>`_ allows to access all
the Open Data available in the Tourism domain by simply browsing
the content of the various datasets.

You can simply use those data for your convenience, or you might
even find a novel way to exploit those data and use them in an
app or portal you are going to develop. A detailed howto is
available: :ref:`tourism-data-browser-howto` to help you getting
acquainted with the browser.

Currently, the Data Browser is being developed to be able to
access also data in the Mobility domain as well.

.. grid-item-card::
:columns: 6
Expand All @@ -48,29 +53,59 @@ summarised in the following table.
Swagger API interface
^^^^^

Go to the :strong:`Swagger interface` of the datasets in the
Tourism domain, located at
https://tourism.opendatahub.bz.it/swagger/ui/index to learn how
the REST APIs are built and how you can script them to fetch
data for your application. To get started, there is a dedicated
howto: :ref:`tourism-data-howto` that will guide you in the
first steps.

Access the :strong:`Swagger interface` of the datasets in the
Mobility domain, located at
https://mobility.api.opendatahub.bz.it/. Like in the case of the
tourism' Swagger interface, you can learn REST API call for that
domain and fetch data for your application. More possibilities
to interact with the Mobility domain datasets and the
description of the new APIv2 are described in the
:ref:`dedicated howto <get-started-mobility>`.
The |odh| team has developed REST APIs to programmatically
access both the Tourism and Mobility domains. You can access
their swagger interface to browse the data and learn how to use
the API. You will be guided in building the query and will
receive as a result both all the data satisfying the query and
the full query in a format that you can use with the
:command:`curl` command from a shell or a script.

.. tab-set::

.. tab-item:: Mobility resources

* :octicon:`triangle-right` The URL of the Swagger
interface is https://mobility.api.opendatahub.bz.it/

* :octicon:`triangle-right` Check out the `Mobility
dedicated howto` (:ref:`get-started-mobility`) that will
guide you in the first steps.

.. tab-item:: Tourism resources

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

* :octicon:`triangle-right` Check out the `Tourism
dedicated howto` (:ref:`tourism-data-howto`) that will
guide you in the first steps.

.. grid-item-card::
:columns: 6

Web Components
Web Component Store
^^^^^

Web Components are a W3C's effort to provide standard components
for the Web. Anyone can create a Web Component, using standard
languages like CSS, JSON, HTML and share it with other, in this
cae with the |Odh| community.

If you have developed a :term:`Web Component` that you deem
useful for the |odh| project or that can be used on top of data
provided by the |odh|, you can share it and allow other to reuse
it, by making it freely available on |odh|\'s `Web Components
Store <https://webcomponents.opendatahub.bz.it/>`_.

The only requirement for all the Web Components offered through
the Store is that they :strong:`must` be released as an
:ref:`Open Source Licence <odh-license>`, compatible with those
used within the |odh| project.

To help you in the process of publishing your Web Component in
|odh|'s store, check the howto: :ref:`webcomponents`.

.. seealso:: More information about the |odh| project, its goal, and
possibility to interact or collaborate with it can be found in
Expand Down

0 comments on commit 84ef180

Please sign in to comment.