first update of readme #41

Merged
zuul merged 4 commits from readme_update into main 2023-05-12 07:31:18 +00:00
Showing only changes of commit a7743e4c38 - Show all commits

View File

@ -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
tischrei marked this conversation as resolved
Review

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
@ -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
tischrei marked this conversation as resolved
Review

here also syntax is somehow broken, please check and fix

here also syntax is somehow broken, please check and fix
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.