From 3140e24236e046774313dbb0dff712c87a95be58 Mon Sep 17 00:00:00 2001 From: tischrei Date: Tue, 28 Feb 2023 12:22:26 +0000 Subject: [PATCH 1/3] first update of readme --- README.rst | 43 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 39 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 6020cf3d..8dcb9ac8 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,9 @@ -=============================== -ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git -=============================== +============ +otc-metadata +============ + +Link: ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git + Metadata about OTC for Ecosystem @@ -13,6 +16,38 @@ Note that this is a hard requirement. * Source: https://github.com/infra/ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git Features --------- +======== * TODO + +Overview: service.yaml +====================== + +The :code:`service.yaml` file contains all data about services, service +categories and the related documents of each service. The file is +used as a base for several internal and external applications or +websites like the Helpcenter 3.0 where the information about the document +repositories and its properties are stored. + +File structure +-------------- + +The file is based on the yaml-file format and has three main sections +which can be compared with database tables in a relational database. + +* documents: contains the information about every single document and its type +like umn, api-ref etc. +* service category: contains the keyword and title of the service category +* services: contains the repository information about the internal (Gitea) and +external location (GitHub) and all the necessary parameters of the service +itself + +These sections, or better "tables" have +their own keys and foreign keys so that the tables are linked together and +the related information can be fetched. +For the :code:`services` table +the key is :code:`service_type` which has the foreign key in the +:code:`documents` table. So a service can have multiple documents and each +document can only be linked to one service. +The key :code:`service_category` table is :code:`name`of the service category +which is then used in the :code:`services` table as foreign key. -- 2.34.1 From a7743e4c38792ac1d18561e1b08b826b6c702a15 Mon Sep 17 00:00:00 2001 From: tischrei Date: Fri, 12 May 2023 07:18:33 +0000 Subject: [PATCH 2/3] small fix --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8dcb9ac8..c5401d5f 100644 --- a/README.rst +++ b/README.rst @@ -37,7 +37,9 @@ which can be compared with database tables in a relational database. * documents: contains the information about every single document and its type like umn, api-ref etc. + * service category: contains the keyword and title of the service category + * services: contains the repository information about the internal (Gitea) and external location (GitHub) and all the necessary parameters of the service itself @@ -49,5 +51,5 @@ For the :code:`services` table the key is :code:`service_type` which has the foreign key in the :code:`documents` table. So a service can have multiple documents and each document can only be linked to one service. -The key :code:`service_category` table is :code:`name`of the service category +The key :code:`service_category` table is :code:`name` of the service category which is then used in the :code:`services` table as foreign key. -- 2.34.1 From 77a3adf41ee978af3c1ac83e7134b62490e10bd1 Mon Sep 17 00:00:00 2001 From: tischrei Date: Fri, 12 May 2023 07:19:49 +0000 Subject: [PATCH 3/3] fix bullets --- README.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index c5401d5f..bfb44b93 100644 --- a/README.rst +++ b/README.rst @@ -36,13 +36,12 @@ The file is based on the yaml-file format and has three main sections which can be compared with database tables in a relational database. * documents: contains the information about every single document and its type -like umn, api-ref etc. + like umn, api-ref etc. * service category: contains the keyword and title of the service category * services: contains the repository information about the internal (Gitea) and -external location (GitHub) and all the necessary parameters of the service -itself + external location (GitHub) and all the necessary parameters of the service itself These sections, or better "tables" have their own keys and foreign keys so that the tables are linked together and -- 2.34.1