infra/otc-metadata
16
0
Fork 13
Code Issues 5 Pull Requests 1 Packages Releases Wiki Activity

first update of readme #41

Merged
zuul merged 4 commits from readme_update into main 2023-05-12 07:31:18 +00:00
Conversation 6 Commits 4 Files Changed 1 +53 -410
11 changed files with 53 additions and 410 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 3140e24236 - Show all commits

43
README.rst
View File

@ -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
tischrei marked this conversation as resolved
vhasko commented 2023-04-03 07:04:32 +00:00
Review
Copy Link

here syntax is not correct, at least put linebreakers between the bullets

here syntax is not correct, at least put linebreakers between the bullets
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
tischrei marked this conversation as resolved
vhasko commented 2023-04-03 07:06:24 +00:00
Review
Copy Link

here also syntax is somehow broken, please check and fix

here also syntax is somehow broken, please check and fix
which is then used in the :code:`services` table as foreign key.