describe metadata overview

Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-authored-by: tischrei <tino.schreiber@t-systems.com> Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2025-06-13 10:06:02 +00:00
parent 11ba8bf8ce
commit af1a08de5f
6 changed files with 208 additions and 0 deletions
--- a/otc_metadata/data/repositories/README.md
+++ b/otc_metadata/data/repositories/README.md
@ -0,0 +1,47 @@
+# 📁 repositories/
+
+Defines the documentation repositories associated with each service for both internal and public environments. Used for resolving documentation sources and CI sync jobs.
+
+## 🔧 Example: `ecs.yaml`
+
+```yaml
+---
+service_type: ecs
+repositories:
+  - environment: public
+    repo: opentelekomcloud-docs/elastic-cloud-server
+    type: github
+    cloud_environments:
+      - eu_de
+  - environment: internal
+    repo: docs/elastic-cloud-server
+    type: gitea
+    cloud_environments:
+      - eu_de
+  - environment: public
+    repo: opentelekomcloud-docs-swiss/elastic-cloud-server
+    type: github
+    cloud_environments:
+      - swiss
+  - environment: internal
+    repo: docs-swiss/elastic-cloud-server
+    type: gitea
+    cloud_environments:
+      - swiss
+```
+
+## Parameter Options:
+
+| Field          | Type   | Description                                          |
+| -------------- | ------ | ---------------------------------------------------- |
+| `service_type` | string | Links this configuration to a service (`services/`). |
+| `repositories` | list   | List of repositories per environment and cloud.      |
+
+### `repositories` Options:
+
+| Field                | Type   | Allowed Values         | Description                           |
+| -------------------- | ------ | ---------------------- | ------------------------------------- |
+| `environment`        | string | `public`, `internal`   | Visibility level of the repository.   |
+| `repo`               | string | Git path               | Path to the Git repository.           |
+| `type`               | string | `github`, `gitea`      | Type of Git service.                  |
+| `cloud_environments` | list   | e.g., `eu_de`, `swiss` | Supported regions for the repository. |