Merge branch 'glossary'

source/architecture.rst

@@ -33,8 +33,8 @@ 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 data format used in
-the various steps of the data flow.
+The bottom part of :numref:`arch-odh` shows the :term:`data format`
+used in the various steps of the data flow.
 
 Records in the Data Sources can be stored in any format and are
 converted into JSON as DTOs. They are then transmitted to the Writer,
@@ -79,8 +79,8 @@ DTO
 Writer
    With the Writer, we enter in the core of the |bdp|\. Its purpose is
    to receive DTOs from the Data Collectors and store them into the DB
-   and therefore implements all methods to read the DTO's JSON format
-   and to write to the database using SQL.
+   and therefore implements all methods to read the DTO's :term:`JSON`
+   format and to write to the database using SQL.
 
 DAL
    The Data Abstraction Layer is used by both the Writer and the

source/glossary.rst

@@ -0,0 +1,40 @@
+
+Glossary
+========
+
+.. glossary::
+   :sorted:
+
+   API
+      The Application Programming Interface is a collection of methods
+      that a software program makes available to allow interaction
+      with other programs 
+
+   Domain
+   Domains
+      A domain is a category of interest to which one or more datasets
+      belong to.
+
+   Dataset
+   Datasets
+      A dataset is a collection of records that originate from the
+      same Data Source. There is at least one dataset per domain.
+
+   Data format
+      Data format is the way information is encoded and exchanged between
+      applications.
+
+   JSON
+      The JavaScript Object Notation is a lightweight data format to
+      ease the exchange of data between computer and its understanding
+      for humans. Essentially a JSON file is a sequence of key-value
+      pairs, organised into lists (arrays, sequences,
+      vectors). Nesting of key-values and of lists is supported.
+
+   Key-value
+      Also called name-value pair or attribute-name pair, a key-value
+      pair is a simple data structure in which information are stored
+      as tuples {attribute, value}, with no constraint of uniqueness
+      on both attribute and value.
+
+

source/index.rst

@@ -18,6 +18,7 @@ Welcome to |odh| Documentation Repository!
    user
    developer
    corehacker
+   glossary
 
 
 Indices and tables

source/intro.rst

@@ -10,7 +10,7 @@
 This is website of the |ODH| documentation repository, a collection of
 resources about the |odh| project. The website serves as the main
 resource portal for everyone interested in deploying apps based on
-datasets&API provided by the |odh| team.
+:term:`datasets`\ &\ :term:`API` provided by the |odh| team.
 
 The technical stuff is composed of: