Compare commits
	
		
			17 Commits
		
	
	
		
			disable_pd
			...
			dms-rocket
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 08a71565de | |||
| 48c646805c | |||
| 9ceb185bce | |||
| 3bc22e77fb | |||
| f5317b2d16 | |||
| afcebbaa7c | |||
| 7036bfcfcb | |||
| 2a1a04805b | |||
| ccaec1df24 | |||
| de8f63d5ca | |||
| f6b9d03ef7 | |||
| af1a08de5f | |||
| 11ba8bf8ce | |||
| 9f0fa5bc11 | |||
| 1c90e222ae | |||
| dc86ee3773 | |||
| a6993b58b6 | 
							
								
								
									
										26
									
								
								otc_metadata/data/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								otc_metadata/data/README.md
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,26 @@
 | 
			
		||||
# 📁 data/
 | 
			
		||||
 | 
			
		||||
This directory is the core of the metadata structure for Open Telekom Cloud Service Documentation. It contains structured definitions for services, their document types, categories, and repository configurations.
 | 
			
		||||
 | 
			
		||||
## 📂 Folder Overview
 | 
			
		||||
 | 
			
		||||
| Folder Name         | Description                                                                 |
 | 
			
		||||
|---------------------|-----------------------------------------------------------------------------|
 | 
			
		||||
| `services/`          | Contains metadata for each individual service, including its cloud regions and access teams. |
 | 
			
		||||
| `documents/`         | Holds metadata about documentation types (e.g., user guides, API refs) for each service and cloud region. |
 | 
			
		||||
| `service_categories/`| Lists available service categories used to group services (e.g., "Application", "Database"). |
 | 
			
		||||
| `repositories/`      | Defines where the documentation source code is located (GitHub or Gitea) for each service per cloud environment. |
 | 
			
		||||
 | 
			
		||||
## 📦 Usage
 | 
			
		||||
 | 
			
		||||
These metadata files are used to:
 | 
			
		||||
- Build documentation portals.
 | 
			
		||||
- Generate links and visibility rules dynamically.
 | 
			
		||||
- Control contributor access.
 | 
			
		||||
- Connect documentation to source control repositories.
 | 
			
		||||
 | 
			
		||||
Each subfolder contains its own `README.md` with detailed field references and options.
 | 
			
		||||
 | 
			
		||||
## 📎 Example Structure
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
							
								
								
									
										69
									
								
								otc_metadata/data/documents/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										69
									
								
								otc_metadata/data/documents/README.md
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,69 @@
 | 
			
		||||
# 📁 documents/
 | 
			
		||||
 | 
			
		||||
This folder contains metadata about documentation files per service, such as user guides or API references. Each file describes a single document variant for a specific cloud environment.
 | 
			
		||||
 | 
			
		||||
## 🔧 Example: `ecs-umn.yaml`
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
---
 | 
			
		||||
hc_location: usermanual/ecs
 | 
			
		||||
html_location: docs/ecs/umn
 | 
			
		||||
link: /elastic-cloud-server/umn/
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: ecs
 | 
			
		||||
title: User Guide
 | 
			
		||||
type: umn
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
  - name: swiss
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## 🔧 Example: `ecs-api-ref.yaml`
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
---
 | 
			
		||||
hc_location: api/ecs
 | 
			
		||||
html_location: docs/ecs/api-ref
 | 
			
		||||
link: /elastic-cloud-server/api-ref/
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: ecs
 | 
			
		||||
title: API Reference
 | 
			
		||||
type: api-ref
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
  - name: swiss
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Parameter Reference
 | 
			
		||||
 | 
			
		||||
| Field                | Type   | Description                                              |
 | 
			
		||||
| -------------------- | ------ | -------------------------------------------------------- |
 | 
			
		||||
| `hc_location`        | string | Path used in the Horizon Console.                        |
 | 
			
		||||
| `html_location`      | string | Location of the built HTML output.                       |
 | 
			
		||||
| `link`               | string | Target URL segment for this document.                    |
 | 
			
		||||
| `rst_location`       | string | Source folder for `.rst` input.                          |
 | 
			
		||||
| `service_type`       | string | Related service identifier (matches `services/`).        |
 | 
			
		||||
| `title`              | string | Display name of the document.                            |
 | 
			
		||||
| `type`               | string | Document type (e.g., `umn`, `api-ref`, etc.).            |
 | 
			
		||||
| `cloud_environments` | list   | Region-specific metadata like visibility or PDF support. |
 | 
			
		||||
 | 
			
		||||
### `cloud_environments` Options:
 | 
			
		||||
 | 
			
		||||
| Field            | Type    | Allowed Values                 | Description                        |
 | 
			
		||||
| ---------------- | ------- | ------------------------------ | ---------------------------------- |
 | 
			
		||||
| `name`           | string  | e.g., `eu_de`, `swiss`         | Name of the cloud region.          |
 | 
			
		||||
| `visibility`     | string  | `public`, `internal`, `hidden` | Document visibility level.         |
 | 
			
		||||
| `pdf_visibility` | string  | `public`, `internal`, `hidden` | PDF visibility level               |
 | 
			
		||||
| `pdf_enabled`    | boolean | `true`, `false`                | Enable PDF export                  |
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/asm
 | 
			
		||||
html_location: docs/asm/best-practice
 | 
			
		||||
link: /application-service-mesh/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: asm
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
    disable_import: true
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/bcc-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/bcc-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: api/bcc
 | 
			
		||||
html_location: docs/bcc/api-ref
 | 
			
		||||
link: /business-continuity-center/api-ref/
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: bcc
 | 
			
		||||
title: API Reference
 | 
			
		||||
type: api-ref
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: internal
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/bcc-umn.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/bcc-umn.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: usermanual/bcc
 | 
			
		||||
html_location: docs/bcc/umn
 | 
			
		||||
link: /business-continuity-center/umn/
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: bcc
 | 
			
		||||
title: User Guide
 | 
			
		||||
type: umn
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: internal
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/cbr
 | 
			
		||||
html_location: docs/cbr/best-practice
 | 
			
		||||
link: /cloud-backup-recovery/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: cbr
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -14,4 +14,4 @@ cloud_environments:
 | 
			
		||||
  - name: swiss
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/cce
 | 
			
		||||
html_location: docs/cce/best-practice
 | 
			
		||||
link: /cloud-container-engine/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: cce
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
@ -14,4 +14,4 @@ cloud_environments:
 | 
			
		||||
  - name: swiss
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/css-koosearch-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/css-koosearch-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: koosearch-api/css
 | 
			
		||||
html_location: docs/css/koosearch-api-ref
 | 
			
		||||
link: /cloud-search-service/koosearch-api-ref/
 | 
			
		||||
rst_location: doc/koosearch-api-ref/source
 | 
			
		||||
service_type: css
 | 
			
		||||
title: Koosearch API Reference
 | 
			
		||||
type: koosearch-api-ref
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/css-koosearch-umn.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/css-koosearch-umn.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: koosearch-usermanual/css
 | 
			
		||||
html_location: docs/css/koosearch-umn
 | 
			
		||||
link: /cloud-search-service/koosearch-umn/
 | 
			
		||||
rst_location: doc/koosearch-umn/source
 | 
			
		||||
service_type: css
 | 
			
		||||
title: Koosearch User Guide
 | 
			
		||||
type: koosearch-umn
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/dc
 | 
			
		||||
html_location: docs/dc/best-practice
 | 
			
		||||
link: /direct-connect/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dc
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/dcs
 | 
			
		||||
html_location: docs/dcs/best-practice
 | 
			
		||||
link: /distributed-cache-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dcs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/dds
 | 
			
		||||
html_location: docs/dds/best-practice
 | 
			
		||||
link: /document-database-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dds
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,13 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: api/dis
 | 
			
		||||
html_location: docs/dis/api-ref
 | 
			
		||||
link: /data-ingestion-service/api-ref/
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dis
 | 
			
		||||
title: API Reference
 | 
			
		||||
type: api-ref
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,13 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: usermanual/dis
 | 
			
		||||
html_location: docs/dis/umn
 | 
			
		||||
link: /data-ingestion-service/umn/
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dis
 | 
			
		||||
title: User Guide
 | 
			
		||||
type: umn
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/dms
 | 
			
		||||
html_location: docs/dms/best-practice
 | 
			
		||||
link: /distributed-message-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dms
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/dms_rocketmq-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/dms_rocketmq-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: api/hrm
 | 
			
		||||
html_location: docs/dms_rocketmq/api-ref
 | 
			
		||||
link: /distributed-message-service-rocketmq/api-ref/
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dms_rocketmq
 | 
			
		||||
title: API Reference
 | 
			
		||||
type: api-ref
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/dms_rocketmq-umn.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/dms_rocketmq-umn.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: usermanual/hrm
 | 
			
		||||
html_location: docs/dms_rocketmq/umn
 | 
			
		||||
link: /distributed-message-service-rocketmq/umn/
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dms_rocketmq
 | 
			
		||||
title: User Guide
 | 
			
		||||
type: umn
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/dns
 | 
			
		||||
html_location: docs/dns/best-practice
 | 
			
		||||
link: /domain-name-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dns
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/drs
 | 
			
		||||
html_location: docs/drs/best-practice
 | 
			
		||||
link: /data-replication-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: drs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/ecs
 | 
			
		||||
html_location: docs/ecs/best-practice
 | 
			
		||||
link: /elastic-cloud-server/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: ecs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/elb
 | 
			
		||||
html_location: docs/elb/best-practice
 | 
			
		||||
link: /elastic-load-balancing/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: elb
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/evs
 | 
			
		||||
html_location: docs/evs/best-practice
 | 
			
		||||
link: /elastic-volume-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: evs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/functiongraph
 | 
			
		||||
html_location: docs/fg/best-practice
 | 
			
		||||
link: /function-graph/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: fg
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/iam
 | 
			
		||||
html_location: docs/iam/best-practice
 | 
			
		||||
link: /identity-access-management/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: iam
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -8,10 +8,10 @@ title: Permissions
 | 
			
		||||
type: permissions
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
  - name: swiss
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/ims
 | 
			
		||||
html_location: docs/ims/best-practice
 | 
			
		||||
link: /image-management-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: ims
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -10,4 +10,4 @@ cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/mrs
 | 
			
		||||
html_location: docs/mrs/best-practice
 | 
			
		||||
link: /mapreduce-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: mrs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
@ -10,4 +10,4 @@ cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/natgw
 | 
			
		||||
html_location: docs/natgw/best-practice
 | 
			
		||||
link: /nat-gateway/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: natgw
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/obs
 | 
			
		||||
html_location: docs/obs/best-practice
 | 
			
		||||
link: /object-storage-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: obs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/obs_3rd_party-c-sdk.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/obs_3rd_party-c-sdk.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: sdk/c-devg-obs
 | 
			
		||||
html_location: docs/obs_3rd_party/c_sdk
 | 
			
		||||
link: /object-storage-service-3rd-party/c-sdk/
 | 
			
		||||
rst_location: doc/c-sdk/source
 | 
			
		||||
service_type: obs_3rd_party
 | 
			
		||||
title: C SDK
 | 
			
		||||
type: c-sdk
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/obs_3rd_party-go-sdk.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/obs_3rd_party-go-sdk.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: sdk/go-devg-obs
 | 
			
		||||
html_location: docs/obs_3rd_party/go_sdk
 | 
			
		||||
link: /object-storage-service-3rd-party/go-sdk/
 | 
			
		||||
rst_location: doc/go-sdk/source
 | 
			
		||||
service_type: obs_3rd_party
 | 
			
		||||
title: Go SDK
 | 
			
		||||
type: go-sdk
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/obs_3rd_party-java-sdk.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/obs_3rd_party-java-sdk.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: sdk/java-devg-obs
 | 
			
		||||
html_location: docs/obs_3rd_party/java_sdk
 | 
			
		||||
link: /object-storage-service-3rd-party/java-sdk/
 | 
			
		||||
rst_location: doc/java-sdk/source
 | 
			
		||||
service_type: obs_3rd_party
 | 
			
		||||
title: Java SDK
 | 
			
		||||
type: java-sdk
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: false
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/sfs
 | 
			
		||||
html_location: docs/sfs/best-practice
 | 
			
		||||
link: /scalable-file-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: sfs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/swr
 | 
			
		||||
html_location: docs/swr/best-practice
 | 
			
		||||
link: /software-repository-container/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: swr
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -8,6 +8,6 @@ title: API Reference
 | 
			
		||||
type: api-ref
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
 | 
			
		||||
@ -9,6 +9,6 @@ title: User Guide
 | 
			
		||||
type: umn
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    visibility: public
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/tms
 | 
			
		||||
html_location: docs/tms/best-practice
 | 
			
		||||
link: /tag-management-service/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: tms
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/ucs-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/ucs-api-ref.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: api/ucs
 | 
			
		||||
html_location: docs/ucs/api-ref
 | 
			
		||||
link: /ubiquitous-cloud-native-service/api-ref/
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: ucs
 | 
			
		||||
title: API Reference
 | 
			
		||||
type: api-ref
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: internal
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/documents/ucs-umn.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/documents/ucs-umn.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: usermanual/ucs
 | 
			
		||||
html_location: docs/ucs/umn
 | 
			
		||||
link: /ubiquitous-cloud-native-service/umn/
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: ucs
 | 
			
		||||
title: User Guide
 | 
			
		||||
type: umn
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: internal
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/vpc
 | 
			
		||||
html_location: docs/vpc/best-practice
 | 
			
		||||
link: /virtual-private-cloud/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: vpc
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
@ -1,14 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
hc_location: bestpractice/waf
 | 
			
		||||
html_location: docs/wafd/best-practice
 | 
			
		||||
link: /web-application-firewall-dedicated/best-practice/
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: wafd
 | 
			
		||||
title: Best Practice
 | 
			
		||||
type: best-practice
 | 
			
		||||
disable_import: true
 | 
			
		||||
cloud_environments:
 | 
			
		||||
  - name: eu_de
 | 
			
		||||
    visibility: internal
 | 
			
		||||
    pdf_visibility: public
 | 
			
		||||
    pdf_enabled: true
 | 
			
		||||
							
								
								
									
										
											BIN
										
									
								
								otc_metadata/data/folder_structure.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								otc_metadata/data/folder_structure.png
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 15 KiB  | 
							
								
								
									
										47
									
								
								otc_metadata/data/repositories/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										47
									
								
								otc_metadata/data/repositories/README.md
									
									
									
									
									
										Normal file
									
								
							@ -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. |
 | 
			
		||||
@ -1,13 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
service_type: dis
 | 
			
		||||
service_type: bcc
 | 
			
		||||
repositories:
 | 
			
		||||
  - environment: public
 | 
			
		||||
    repo: opentelekomcloud-docs/data-ingestion-service
 | 
			
		||||
    repo: opentelekomcloud-docs/business-continuity-center
 | 
			
		||||
    type: github
 | 
			
		||||
    cloud_environments:
 | 
			
		||||
      - eu_de
 | 
			
		||||
  - environment: internal
 | 
			
		||||
    repo: docs/data-ingestion-service
 | 
			
		||||
    repo: docs/business-continuity-center
 | 
			
		||||
    type: gitea
 | 
			
		||||
    cloud_environments:
 | 
			
		||||
      - eu_de
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/repositories/dms_rocketmq.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/repositories/dms_rocketmq.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
service_type: dms_rocketmq
 | 
			
		||||
repositories:
 | 
			
		||||
  - environment: public
 | 
			
		||||
    repo: opentelekomcloud-docs/distributed-message-service-rocketmq
 | 
			
		||||
    type: github
 | 
			
		||||
    cloud_environments:
 | 
			
		||||
      - eu_de
 | 
			
		||||
  - environment: internal
 | 
			
		||||
    repo: docs/distributed-message-service-rocketmq
 | 
			
		||||
    type: gitea
 | 
			
		||||
    cloud_environments:
 | 
			
		||||
      - eu_de
 | 
			
		||||
							
								
								
									
										13
									
								
								otc_metadata/data/repositories/ucs.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								otc_metadata/data/repositories/ucs.yaml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,13 @@
 | 
			
		||||
---
 | 
			
		||||
service_type: ucs
 | 
			
		||||
repositories:
 | 
			
		||||
  - environment: public
 | 
			
		||||
    repo: opentelekomcloud-docs/ubiquitous-cloud-native-service
 | 
			
		||||
    type: github
 | 
			
		||||
    cloud_environments:
 | 
			
		||||
      - eu_de
 | 
			
		||||
  - environment: internal
 | 
			
		||||
    repo: docs/ubiquitous-cloud-native-service
 | 
			
		||||
    type: gitea
 | 
			
		||||
    cloud_environments:
 | 
			
		||||
      - eu_de
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user