Skip to content

Commit

Permalink
Merge pull request #127 from noi-techpark/issue-103-sphinx3.0.3-compa…
Browse files Browse the repository at this point in the history
…tibility

fixed glossary references #103
  • Loading branch information
stefanodavid committed May 1, 2020
2 parents f181645 + af02f4c commit 834cbde
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ data from :strong:`Data Sources` and make them available to
:strong:`Data Consumers`, which are usually third-party applications
that use those data in any way that they deem useful, including (but
not limited to) study the evolution of historical data, or carry out
data analysis to produce :term:`statistical graphics`.
data analysis to produce :term:`Statistical Graphics`.

.. _arch-odh:

Expand All @@ -31,7 +31,7 @@ correctly import the data. Dual to the :program:`dc-interface`, the
:program:`ws-interface` allows the export of DTOs to web services,
that expose them to :strong:`Data Consumers`.

The bottom part of :numref:`arch-odh` shows the :term:`data format`
The bottom part of :numref:`arch-odh` shows the :term:`Data Format`
used in the various steps of the data flow. Since the data are exposed
in JSON, it is possible to develop applications in any language that
uses them.
Expand Down
2 changes: 1 addition & 1 deletion source/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ There are currently two different authentication methods available:

The OAuth2 authentication mechanism Authentication tokens are
based on :term:`JSON Web Token (JWT) <JSON Web Token>` as defined in
:rfc:`7519#section-3`, to send :term:`claims <claim>`.
:rfc:`7519#section-3`, to send :term:`claims <Claim>`.

For those not familiar with the OAuth2 mechanism, here is a quick
description of the client-server interaction:
Expand Down
2 changes: 1 addition & 1 deletion source/domains.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

A :term:`domain` is a category that contains entities that are closely
A :term:`Domain` is a category that contains entities that are closely
related. In the |odh|, each domain roughly identifies one social or
economical category; the domains intended as sources for data served
by the |odh| are depicted at the bottom of :numref:`domains-diagram`.
Expand Down
7 changes: 4 additions & 3 deletions source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Glossary

.. glossary::
:sorted:


API
The Application Programming Interface is a collection of methods
Expand All @@ -18,7 +19,7 @@ Glossary
A dataset is a collection of records from a Data source. See the
:ref:`detailed description <dataset-def>`.

Data format
Data Format
Data format is the way information is encoded and exchanged between
applications.

Expand Down Expand Up @@ -89,7 +90,7 @@ Glossary
the :ref:`detailed description <data-consumer-def>`.


Persistence layer
Persistence Layer
Another name for Database, see the above entry or the
:ref:`detailed description <database-def>`.

Expand All @@ -103,7 +104,7 @@ Glossary
for authentication purposes when the claim is digitally signed
and/or encrypted.

Statistical graphics
Statistical Graphics
Statistical graphics are means to display statistical data with
the purpose to ease their interpretations. Common statistical
graphics include pie charts, histograms, and scatter plot.
Expand Down
2 changes: 1 addition & 1 deletion source/howto/tourism/tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ filters prefixed with :strong:`odh` stand for?

|a| In the datasets, there are filters like `active` and `odhactive`,
where `odh` simply stands for |odh|. Filters starting with
:strong:`odh` are collectively called :term:`odhtags`.
:strong:`odh` are collectively called :term:`ODHtags`.

Datasets filtered with the former return all data sent by
the dataset provider, while the latter returns those validated by the
Expand Down
4 changes: 2 additions & 2 deletions source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
This is the website of the |ODH| documentation, a collection of
technical resources about the |odh| project. The website serves as the
main resource portal for everyone interested in accessing the data or
deploying apps based on :term:`datasets <dataset>` & :term:`API`\s
deploying apps based on :term:`datasets <Dataset>` & :term:`API`\s
provided by the |odh| team.

The technical stuff is composed of:
Expand Down Expand Up @@ -59,7 +59,7 @@ maturity: production stage, beta and alpha stage.
An overview of the |odh| Project.

:numref:`domains-diagram` gives a high level overview of the flow of
data within the |odh|\: at the bottom, :term:`sensors <sensor>` gather
data within the |odh|\: at the bottom, :term:`sensors <Sensor>` gather
data from various domains, which are fed to the |odh| Big Data
infrastructure and made available through endpoints to (third-party)
applications, web sites, and vocal assistants. A more technical and
Expand Down

0 comments on commit 834cbde

Please sign in to comment.