Tino Schreiber
6d7413c697
All checks were successful
gl/check check status: success (6d7413c69745980f78b587cd4ad0aad55a918dd6)
68 lines
2.5 KiB
ReStructuredText
68 lines
2.5 KiB
ReStructuredText
============
|
|
otc-metadata
|
|
============
|
|
|
|
Link: ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git
|
|
|
|
|
|
Metadata about OTC for Ecosystem
|
|
|
|
Please fill here a long description which must be at least 3 lines wrapped on
|
|
80 cols, so that distribution package maintainers can use it in their packages.
|
|
Note that this is a hard requirement.
|
|
|
|
* Free software: Apache license
|
|
* Documentation: https://docs.otc.t-systems.com/ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git
|
|
* 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.
|
|
|
|
File structure: documents
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
* hc_location: reference to Huawei Cloud part
|
|
* html_location: place where the documents are stored in doc-exports
|
|
* link: URI document
|
|
* pdf_enabled: true| false ; enable pdf generation
|
|
* pdf_enviroment public|internal|hidden: environment where the pdfs are shown in the SBV
|
|
* rst_location: folder location of this specific in the source repo
|
|
* service_type: primary key of service name
|
|
* title: written title of the service
|
|
* type: document type
|