diff --git a/README.rst b/README.rst index bfb44b93..617dec9f 100644 --- a/README.rst +++ b/README.rst @@ -52,3 +52,16 @@ the key is :code:`service_type` which has the foreign key in the 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 diff --git a/otc_metadata/data/documents/ac-blueprints.yaml b/otc_metadata/data/documents/ac-blueprints.yaml deleted file mode 100644 index 0c0f6fb4..00000000 --- a/otc_metadata/data/documents/ac-blueprints.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -environment: public -link: /architecture-center/blueprints/ -pdf_name: architecture-center-blueprints -rst_location: doc/blueprints/source -service_type: ac -title: Blueprints -type: blueprints -disable_import: true diff --git a/otc_metadata/data/documents/ac-cloud-adoption-framework.yaml b/otc_metadata/data/documents/ac-cloud-adoption-framework.yaml deleted file mode 100644 index b01d6be3..00000000 --- a/otc_metadata/data/documents/ac-cloud-adoption-framework.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -environment: internal -link: /architecture-center/caf/ -pdf_name: architecture-center-cloud-adoption-framework -rst_location: doc/caf/source -service_type: ac -title: Cloud Adoption Framework -type: caf -disable_import: true diff --git a/otc_metadata/data/documents/antiddos-api-ref.yaml b/otc_metadata/data/documents/antiddos-api-ref.yaml index 0dcc2ccd..8f115201 100644 --- a/otc_metadata/data/documents/antiddos-api-ref.yaml +++ b/otc_metadata/data/documents/antiddos-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/antiddos html_location: docs/antiddos/api-ref link: /anti-ddos/api-ref/ -pdf_name: antiddos-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: antiddos title: API Reference diff --git a/otc_metadata/data/documents/antiddos-umn.yaml b/otc_metadata/data/documents/antiddos-umn.yaml index 6e837c66..4d6c5879 100644 --- a/otc_metadata/data/documents/antiddos-umn.yaml +++ b/otc_metadata/data/documents/antiddos-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/antiddos html_location: docs/antiddos/umn link: /anti-ddos/umn/ -pdf_name: antiddos-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: antiddos title: User Guide diff --git a/otc_metadata/data/documents/aom-api-ref.yaml b/otc_metadata/data/documents/aom-api-ref.yaml index 37f3d122..d5d0131b 100644 --- a/otc_metadata/data/documents/aom-api-ref.yaml +++ b/otc_metadata/data/documents/aom-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/aom html_location: docs/aom/api-ref link: /application-operations-management/api-ref/ -pdf_name: aom-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: aom title: API Reference diff --git a/otc_metadata/data/documents/aom-umn.yaml b/otc_metadata/data/documents/aom-umn.yaml index 6553aba4..9dbe593a 100644 --- a/otc_metadata/data/documents/aom-umn.yaml +++ b/otc_metadata/data/documents/aom-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/aom html_location: docs/aom/umn link: /application-operations-management/umn/ -pdf_name: aom-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: aom title: User Guide diff --git a/otc_metadata/data/documents/aom2-api-ref.yaml b/otc_metadata/data/documents/aom2-api-ref.yaml index 3de28708..6e196e95 100644 --- a/otc_metadata/data/documents/aom2-api-ref.yaml +++ b/otc_metadata/data/documents/aom2-api-ref.yaml @@ -3,7 +3,8 @@ environment: internal hc_location: api/aom2 html_location: docs/aom2/api-ref link: /application-operations-management-2/api-ref/ -pdf_name: aom2-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: aom2 title: API Reference diff --git a/otc_metadata/data/documents/aom2-umn.yaml b/otc_metadata/data/documents/aom2-umn.yaml index 6d33384a..e013a239 100644 --- a/otc_metadata/data/documents/aom2-umn.yaml +++ b/otc_metadata/data/documents/aom2-umn.yaml @@ -3,7 +3,8 @@ environment: internal hc_location: usermanual/aom2 html_location: docs/aom2/umn link: /application-operations-management-2/umn/ -pdf_name: aom2-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: aom2 title: User Guide diff --git a/otc_metadata/data/documents/apig-api-ref.yaml b/otc_metadata/data/documents/apig-api-ref.yaml index 77dbff26..22d8d534 100644 --- a/otc_metadata/data/documents/apig-api-ref.yaml +++ b/otc_metadata/data/documents/apig-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/apig html_location: docs/apig/api-ref link: /api-gateway/api-ref/ -pdf_name: apig-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: apig title: API Reference diff --git a/otc_metadata/data/documents/apig-dev.yaml b/otc_metadata/data/documents/apig-dev.yaml index 2166b214..ee1ea6f9 100644 --- a/otc_metadata/data/documents/apig-dev.yaml +++ b/otc_metadata/data/documents/apig-dev.yaml @@ -3,7 +3,8 @@ environment: hidden hc_location: devg/apig html_location: docs/apig/dev link: /api-gateway/dev-guide/ -pdf_name: apig-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: apig title: Developer Guide diff --git a/otc_metadata/data/documents/apig-umn.yaml b/otc_metadata/data/documents/apig-umn.yaml index eba1868b..bb6dc455 100644 --- a/otc_metadata/data/documents/apig-umn.yaml +++ b/otc_metadata/data/documents/apig-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/apig html_location: docs/apig/umn link: /api-gateway/umn/ -pdf_name: apig-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: apig title: User Guide diff --git a/otc_metadata/data/documents/apiu-guidelines.yaml b/otc_metadata/data/documents/apiu-guidelines.yaml index 8bf7a57f..8f421b1c 100644 --- a/otc_metadata/data/documents/apiu-guidelines.yaml +++ b/otc_metadata/data/documents/apiu-guidelines.yaml @@ -1,9 +1,9 @@ --- -environment: internal hc_location: api-usage/guidelines html_location: docs/apiu/guidelines link: /api-usage/guidelines/ -pdf_name: apiu-guidelines +pdf_enabled: true +pdf_environment: public rst_location: doc/guidelines/source service_type: apiu title: API Usage Guidelines diff --git a/otc_metadata/data/documents/apm-api-ref.yaml b/otc_metadata/data/documents/apm-api-ref.yaml index 601fc0b1..41e846c0 100644 --- a/otc_metadata/data/documents/apm-api-ref.yaml +++ b/otc_metadata/data/documents/apm-api-ref.yaml @@ -3,7 +3,8 @@ environment: internal hc_location: api/apm html_location: docs/apm/api-ref link: /application-performance-management/api-ref/ -pdf_name: apm-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: apm title: API Reference diff --git a/otc_metadata/data/documents/apm-umn.yaml b/otc_metadata/data/documents/apm-umn.yaml index 785ed7b7..2ce8048f 100644 --- a/otc_metadata/data/documents/apm-umn.yaml +++ b/otc_metadata/data/documents/apm-umn.yaml @@ -3,7 +3,8 @@ environment: public hc_location: usermanual/apm html_location: docs/apm/umn link: /application-performance-management/umn/ -pdf_name: apm-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: apm title: User Guide diff --git a/otc_metadata/data/documents/as-api-ref.yaml b/otc_metadata/data/documents/as-api-ref.yaml index 2fb205bc..a358f055 100644 --- a/otc_metadata/data/documents/as-api-ref.yaml +++ b/otc_metadata/data/documents/as-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/as html_location: docs/as/api-ref link: /auto-scaling/api-ref/ -pdf_name: as-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: as title: API Reference diff --git a/otc_metadata/data/documents/as-dev.yaml b/otc_metadata/data/documents/as-dev.yaml index 2ceb12cf..33485809 100644 --- a/otc_metadata/data/documents/as-dev.yaml +++ b/otc_metadata/data/documents/as-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/as html_location: docs/as/dev link: /auto-scaling/dev-guide/ -pdf_name: as-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: as title: Developer Guide diff --git a/otc_metadata/data/documents/as-umn.yaml b/otc_metadata/data/documents/as-umn.yaml index 38a8a0da..92afa4a5 100644 --- a/otc_metadata/data/documents/as-umn.yaml +++ b/otc_metadata/data/documents/as-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/as html_location: docs/as/umn link: /auto-scaling/umn/ -pdf_name: as-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: as title: User Guide diff --git a/otc_metadata/data/documents/asm-api-ref.yaml b/otc_metadata/data/documents/asm-api-ref.yaml index 01fd6c5d..08f05729 100644 --- a/otc_metadata/data/documents/asm-api-ref.yaml +++ b/otc_metadata/data/documents/asm-api-ref.yaml @@ -1,9 +1,10 @@ --- -environment: internal +environment: public hc_location: api/asm html_location: docs/asm/api-ref link: /application-service-mesh/api-ref/ -pdf_name: asm-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: asm title: API Reference diff --git a/otc_metadata/data/documents/asm-best-practice.yaml b/otc_metadata/data/documents/asm-best-practice.yaml index 6e00dc11..cf408d88 100644 --- a/otc_metadata/data/documents/asm-best-practice.yaml +++ b/otc_metadata/data/documents/asm-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/asm environment: internal html_location: docs/asm/best-practice link: /application-service-mesh/best-practice/ -pdf_name: asm-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: asm title: Best Practice diff --git a/otc_metadata/data/documents/asm-umn.yaml b/otc_metadata/data/documents/asm-umn.yaml index d96dc07e..9c691adb 100644 --- a/otc_metadata/data/documents/asm-umn.yaml +++ b/otc_metadata/data/documents/asm-umn.yaml @@ -1,9 +1,10 @@ --- -environment: internal +environment: public hc_location: usermanual/asm html_location: docs/asm/umn link: /application-service-mesh/umn/ -pdf_name: asm-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: asm title: User Guide diff --git a/otc_metadata/data/documents/bd-umn.yaml b/otc_metadata/data/documents/bd-umn.yaml index ecfb9ddf..f0421f51 100644 --- a/otc_metadata/data/documents/bd-umn.yaml +++ b/otc_metadata/data/documents/bd-umn.yaml @@ -1,6 +1,8 @@ --- link: /business-dashboard/umn/ rst_location: umn/source +pdf_enabled: false +pdf_environment: hidden service_type: bd title: User Guide type: umn diff --git a/otc_metadata/data/documents/blueprints-best-practice.yaml b/otc_metadata/data/documents/blueprints-best-practice.yaml deleted file mode 100644 index 0439a8f0..00000000 --- a/otc_metadata/data/documents/blueprints-best-practice.yaml +++ /dev/null @@ -1,11 +0,0 @@ ---- -hc_location: bestpractice/blueprints -environment: internal -html_location: docs/blueprints/best-practice -link: /blueprints/best-practice/ -pdf_name: blueprints-best-practice -rst_location: doc/best-practice/source -service_type: blueprints -title: Best Practice -type: best-practice -disable_import: true diff --git a/otc_metadata/data/documents/bms-api-ref.yaml b/otc_metadata/data/documents/bms-api-ref.yaml index ec1c7846..82f087c8 100644 --- a/otc_metadata/data/documents/bms-api-ref.yaml +++ b/otc_metadata/data/documents/bms-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/bms html_location: docs/bms/api-ref link: /bare-metal-server/api-ref/ -pdf_name: bms-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: bms title: API Reference diff --git a/otc_metadata/data/documents/bms-dev.yaml b/otc_metadata/data/documents/bms-dev.yaml index 234963f8..799cbfa6 100644 --- a/otc_metadata/data/documents/bms-dev.yaml +++ b/otc_metadata/data/documents/bms-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/bms html_location: docs/bms/dev link: /bare-metal-server/dev-guide/ -pdf_name: bms-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: bms title: Developer Guide diff --git a/otc_metadata/data/documents/bms-image-creation-guide.yaml b/otc_metadata/data/documents/bms-image-creation-guide.yaml index db391e74..cc3e9599 100644 --- a/otc_metadata/data/documents/bms-image-creation-guide.yaml +++ b/otc_metadata/data/documents/bms-image-creation-guide.yaml @@ -2,7 +2,8 @@ hc_location: bpicg/bms html_location: docs/bms/image-creation-guide link: /bare-metal-server/image-creation-guide/ -pdf_name: bms-image-creation-guide +pdf_enabled: true +pdf_environment: public rst_location: doc/image-creation-guide/source service_type: bms title: Private Image Creation Guide diff --git a/otc_metadata/data/documents/bms-umn.yaml b/otc_metadata/data/documents/bms-umn.yaml index c9807162..258a6995 100644 --- a/otc_metadata/data/documents/bms-umn.yaml +++ b/otc_metadata/data/documents/bms-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/bms html_location: docs/bms/umn link: /bare-metal-server/umn/ -pdf_name: bms-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: bms title: User Guide diff --git a/otc_metadata/data/documents/cbr-api-ref.yaml b/otc_metadata/data/documents/cbr-api-ref.yaml index e7cfc1af..537e7013 100644 --- a/otc_metadata/data/documents/cbr-api-ref.yaml +++ b/otc_metadata/data/documents/cbr-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/cbr html_location: docs/cbr/api-ref link: /cloud-backup-recovery/api-ref/ -pdf_name: cbr-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: cbr title: API Reference diff --git a/otc_metadata/data/documents/cbr-best-practice.yaml b/otc_metadata/data/documents/cbr-best-practice.yaml index e487dd27..3e0683e1 100644 --- a/otc_metadata/data/documents/cbr-best-practice.yaml +++ b/otc_metadata/data/documents/cbr-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/cbr environment: internal html_location: docs/cbr/best-practice link: /cloud-backup-recovery/best-practice/ -pdf_name: cbr-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: cbr title: Best Practice diff --git a/otc_metadata/data/documents/cbr-umn.yaml b/otc_metadata/data/documents/cbr-umn.yaml index 960049bd..26123b01 100644 --- a/otc_metadata/data/documents/cbr-umn.yaml +++ b/otc_metadata/data/documents/cbr-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/cbr html_location: docs/cbr/umn link: /cloud-backup-recovery/umn/ -pdf_name: cbr-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: cbr title: User Guide diff --git a/otc_metadata/data/documents/cc-api-ref.yaml b/otc_metadata/data/documents/cc-api-ref.yaml index bfb19529..aea29e1b 100644 --- a/otc_metadata/data/documents/cc-api-ref.yaml +++ b/otc_metadata/data/documents/cc-api-ref.yaml @@ -1,6 +1,7 @@ --- link: /cloud-create/api-ref/ -pdf_name: cc-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: cc title: API Reference diff --git a/otc_metadata/data/documents/cc-umn.yaml b/otc_metadata/data/documents/cc-umn.yaml index ba9d6533..3795ca64 100644 --- a/otc_metadata/data/documents/cc-umn.yaml +++ b/otc_metadata/data/documents/cc-umn.yaml @@ -1,7 +1,8 @@ --- html_location: docs/cc/umn link: /cloud-create/umn/ -pdf_name: cc-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: cc title: User Guide diff --git a/otc_metadata/data/documents/cce-api-ref.yaml b/otc_metadata/data/documents/cce-api-ref.yaml index b8a95c69..f3ca3486 100644 --- a/otc_metadata/data/documents/cce-api-ref.yaml +++ b/otc_metadata/data/documents/cce-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api2/cce html_location: docs/cce/api-ref link: /cloud-container-engine/api-ref/ -pdf_name: cce-api-ref +pdf_enabled: false +pdf_environment: public rst_location: api-ref/source service_type: cce title: API Reference diff --git a/otc_metadata/data/documents/cce-best-practice.yaml b/otc_metadata/data/documents/cce-best-practice.yaml index 6d4f7c00..fd86259d 100644 --- a/otc_metadata/data/documents/cce-best-practice.yaml +++ b/otc_metadata/data/documents/cce-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/cce environment: internal html_location: docs/cce/best-practice link: /cloud-container-engine/best-practice/ -pdf_name: cce-best-practice +pdf_enabled: false +pdf_environment: public rst_location: doc/best-practice/source service_type: cce title: Best Practice diff --git a/otc_metadata/data/documents/cce-umn.yaml b/otc_metadata/data/documents/cce-umn.yaml index 10601cd2..1e6413f5 100644 --- a/otc_metadata/data/documents/cce-umn.yaml +++ b/otc_metadata/data/documents/cce-umn.yaml @@ -2,6 +2,8 @@ hc_location: usermanual2/cce html_location: docs/cce/umn link: /cloud-container-engine/umn/ +pdf_enabled: false +pdf_environment: public rst_location: umn/source service_type: cce title: User Guide diff --git a/otc_metadata/data/documents/cci-api-ref.yaml b/otc_metadata/data/documents/cci-api-ref.yaml index eb0afe55..aa246a3e 100644 --- a/otc_metadata/data/documents/cci-api-ref.yaml +++ b/otc_metadata/data/documents/cci-api-ref.yaml @@ -1,9 +1,10 @@ --- hc_location: api/cci -environment: internal +environment: public html_location: docs/cci/api-ref link: /cloud-container-instance/api-ref/ -pdf_name: cci-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: cci title: API Reference diff --git a/otc_metadata/data/documents/cci-umn.yaml b/otc_metadata/data/documents/cci-umn.yaml index 60e86ec7..295fa24c 100644 --- a/otc_metadata/data/documents/cci-umn.yaml +++ b/otc_metadata/data/documents/cci-umn.yaml @@ -1,9 +1,10 @@ --- hc_location: usermanual/cci -environment: internal +environment: public html_location: docs/cci/umn link: /cloud-container-instance/umn/ -pdf_name: cci-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: cci title: User Guide diff --git a/otc_metadata/data/documents/ccn-api-ref.yaml b/otc_metadata/data/documents/ccn-api-ref.yaml new file mode 100644 index 00000000..307d10c4 --- /dev/null +++ b/otc_metadata/data/documents/ccn-api-ref.yaml @@ -0,0 +1,11 @@ +--- +environment: internal +hc_location: api/cc +html_location: docs/ccn/api-ref +link: /cloud-connect/api-ref/ +pdf_enabled: true +pdf_environment: public +rst_location: api-ref/source +service_type: ccn +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/ccn-umn.yaml b/otc_metadata/data/documents/ccn-umn.yaml new file mode 100644 index 00000000..1aedd93b --- /dev/null +++ b/otc_metadata/data/documents/ccn-umn.yaml @@ -0,0 +1,11 @@ +--- +environment: internal +hc_location: usermanual/cc +html_location: docs/ccn/umn +link: /cloud-connect/umn/ +pdf_enabled: true +pdf_environment: public +rst_location: umn/source +service_type: ccn +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/ces-api-ref.yaml b/otc_metadata/data/documents/ces-api-ref.yaml index 59745a25..af12aacf 100644 --- a/otc_metadata/data/documents/ces-api-ref.yaml +++ b/otc_metadata/data/documents/ces-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/ces html_location: docs/ces/api-ref link: /cloud-eye/api-ref/ -pdf_name: ces-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: ces title: API Reference diff --git a/otc_metadata/data/documents/ces-umn.yaml b/otc_metadata/data/documents/ces-umn.yaml index 2201ac73..f5d2842b 100644 --- a/otc_metadata/data/documents/ces-umn.yaml +++ b/otc_metadata/data/documents/ces-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/ces html_location: docs/ces/umn link: /cloud-eye/umn/ -pdf_name: ces-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: ces title: User Guide diff --git a/otc_metadata/data/documents/cfw-api-ref.yaml b/otc_metadata/data/documents/cfw-api-ref.yaml index 330f95be..60582157 100644 --- a/otc_metadata/data/documents/cfw-api-ref.yaml +++ b/otc_metadata/data/documents/cfw-api-ref.yaml @@ -1,9 +1,9 @@ --- -environment: internal hc_location: api/cfw html_location: docs/cfw/api-ref link: /cloud-firewall/api-ref/ -pdf_name: cfw-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: cfw title: API Reference diff --git a/otc_metadata/data/documents/cfw-umn.yaml b/otc_metadata/data/documents/cfw-umn.yaml index 3a7e24af..c29d94a9 100644 --- a/otc_metadata/data/documents/cfw-umn.yaml +++ b/otc_metadata/data/documents/cfw-umn.yaml @@ -1,9 +1,9 @@ --- -environment: internal hc_location: usermanual/cfw html_location: docs/cfw/umn link: /cloud-firewall/umn/ -pdf_name: cfw-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: cfw title: User Guide diff --git a/otc_metadata/data/documents/config-api-ref.yaml b/otc_metadata/data/documents/config-api-ref.yaml index 0c3511a0..5f28b71b 100644 --- a/otc_metadata/data/documents/config-api-ref.yaml +++ b/otc_metadata/data/documents/config-api-ref.yaml @@ -1,9 +1,9 @@ --- -environment: internal hc_location: api/rms html_location: docs/config/api-ref link: /config/api-ref/ -pdf_name: config-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: config title: API Reference diff --git a/otc_metadata/data/documents/config-umn.yaml b/otc_metadata/data/documents/config-umn.yaml index afa92127..0a2e9edc 100644 --- a/otc_metadata/data/documents/config-umn.yaml +++ b/otc_metadata/data/documents/config-umn.yaml @@ -1,8 +1,9 @@ --- -environment: internal hc_location: usermanual/rms html_location: docs/config/umn link: /config/umn/ +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: config title: User Guide diff --git a/otc_metadata/data/documents/csbs-api-ref.yaml b/otc_metadata/data/documents/csbs-api-ref.yaml index f024a46f..eda7fc23 100644 --- a/otc_metadata/data/documents/csbs-api-ref.yaml +++ b/otc_metadata/data/documents/csbs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/csbs html_location: docs/csbs/api-ref link: /cloud-server-backup-service/api-ref/ -pdf_name: csbs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: csbs title: API Reference diff --git a/otc_metadata/data/documents/csbs-umn.yaml b/otc_metadata/data/documents/csbs-umn.yaml index d1a8e1d8..ed935fe7 100644 --- a/otc_metadata/data/documents/csbs-umn.yaml +++ b/otc_metadata/data/documents/csbs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/csbs html_location: docs/csbs/umn link: /cloud-server-backup-service/umn/ -pdf_name: csbs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: csbs title: User Guide diff --git a/otc_metadata/data/documents/cse-api-ref.yaml b/otc_metadata/data/documents/cse-api-ref.yaml index 7242c428..41df21f9 100644 --- a/otc_metadata/data/documents/cse-api-ref.yaml +++ b/otc_metadata/data/documents/cse-api-ref.yaml @@ -3,7 +3,8 @@ hc_location: api/cse environment: internal html_location: docs/cse/api-ref link: /cloud-service-engine/api-ref/ -pdf_name: cse-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: cse title: API Reference diff --git a/otc_metadata/data/documents/cse-umn.yaml b/otc_metadata/data/documents/cse-umn.yaml index cade2142..ece85f4d 100644 --- a/otc_metadata/data/documents/cse-umn.yaml +++ b/otc_metadata/data/documents/cse-umn.yaml @@ -3,7 +3,8 @@ hc_location: usermanual/cse environment: internal html_location: docs/cse/umn link: /cloud-service-engine/umn/ -pdf_name: cse-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: cse title: User Guide diff --git a/otc_metadata/data/documents/css-api-ref.yaml b/otc_metadata/data/documents/css-api-ref.yaml index c1d88aa5..02e116f7 100644 --- a/otc_metadata/data/documents/css-api-ref.yaml +++ b/otc_metadata/data/documents/css-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/css html_location: docs/css/api-ref link: /cloud-search-service/api-ref/ -pdf_name: css-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: css title: API Reference diff --git a/otc_metadata/data/documents/css-best-practice.yaml b/otc_metadata/data/documents/css-best-practice.yaml index 66c71aca..19d50483 100644 --- a/otc_metadata/data/documents/css-best-practice.yaml +++ b/otc_metadata/data/documents/css-best-practice.yaml @@ -2,7 +2,8 @@ hc_location: bestpractice/css html_location: docs/css/best-practice link: /cloud-search-service/best-practice/ -pdf_name: css-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: css title: Best Practice diff --git a/otc_metadata/data/documents/css-umn.yaml b/otc_metadata/data/documents/css-umn.yaml index 6d9edf30..db057318 100644 --- a/otc_metadata/data/documents/css-umn.yaml +++ b/otc_metadata/data/documents/css-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/css html_location: docs/css/umn link: /cloud-search-service/umn/ -pdf_name: css-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: css title: User Guide diff --git a/otc_metadata/data/documents/cts-api-ref.yaml b/otc_metadata/data/documents/cts-api-ref.yaml index 593b8667..1220ebad 100644 --- a/otc_metadata/data/documents/cts-api-ref.yaml +++ b/otc_metadata/data/documents/cts-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/cts html_location: docs/cts/api-ref link: /cloud-trace-service/api-ref/ -pdf_name: cts-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: cts title: API Reference diff --git a/otc_metadata/data/documents/cts-umn.yaml b/otc_metadata/data/documents/cts-umn.yaml index c3ee0220..34793415 100644 --- a/otc_metadata/data/documents/cts-umn.yaml +++ b/otc_metadata/data/documents/cts-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/cts html_location: docs/cts/umn link: /cloud-trace-service/umn/ -pdf_name: cts-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: cts title: User Guide diff --git a/otc_metadata/data/documents/das-api-ref.yaml b/otc_metadata/data/documents/das-api-ref.yaml new file mode 100644 index 00000000..c387dd99 --- /dev/null +++ b/otc_metadata/data/documents/das-api-ref.yaml @@ -0,0 +1,11 @@ +--- +hc_location: api/das +environment: internal +html_location: docs/das/api-ref +link: /data-admin-service/api-ref/ +pdf_enabled: true +pdf_environment: public +rst_location: api-ref/source +service_type: das +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/das-umn.yaml b/otc_metadata/data/documents/das-umn.yaml new file mode 100644 index 00000000..9f158a9e --- /dev/null +++ b/otc_metadata/data/documents/das-umn.yaml @@ -0,0 +1,11 @@ +--- +hc_location: usermanual/das +environment: internal +html_location: docs/das/umn +link: /data-admin-service/umn/ +pdf_enabled: true +pdf_environment: public +rst_location: umn/source +service_type: das +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/dataarts_studio-api-ref.yaml b/otc_metadata/data/documents/dataarts_studio-api-ref.yaml index 223a46e5..53998b69 100644 --- a/otc_metadata/data/documents/dataarts_studio-api-ref.yaml +++ b/otc_metadata/data/documents/dataarts_studio-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dataartsstudio html_location: docs/dataartsstudio/api-ref link: /data-arts-studio/api-ref/ -pdf_name: dataarts_studio-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dataarts_studio title: API Reference diff --git a/otc_metadata/data/documents/dataarts_studio-umn.yaml b/otc_metadata/data/documents/dataarts_studio-umn.yaml index a6a78d1c..44383f42 100644 --- a/otc_metadata/data/documents/dataarts_studio-umn.yaml +++ b/otc_metadata/data/documents/dataarts_studio-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dataartsstudio html_location: docs/dataartsstudio/umn link: /data-arts-studio/umn/ -pdf_name: dataarts_studio-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dataarts_studio title: User Guide diff --git a/otc_metadata/data/documents/dbss-api-ref.yaml b/otc_metadata/data/documents/dbss-api-ref.yaml new file mode 100644 index 00000000..3598da55 --- /dev/null +++ b/otc_metadata/data/documents/dbss-api-ref.yaml @@ -0,0 +1,11 @@ +--- +environment: internal +hc_location: api/dbss +html_location: docs/dbss/api-ref +link: /database-security-service/api-ref/ +pdf_enabled: true +pdf_environment: public +rst_location: api-ref/source +service_type: dbss +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/dbss-umn.yaml b/otc_metadata/data/documents/dbss-umn.yaml index b98daeb0..3de424cb 100644 --- a/otc_metadata/data/documents/dbss-umn.yaml +++ b/otc_metadata/data/documents/dbss-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dbss html_location: docs/dbss/umn link: /database-security-service/umn/ -pdf_name: dbss-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dbss title: User Guide diff --git a/otc_metadata/data/documents/dc-api-ref.yaml b/otc_metadata/data/documents/dc-api-ref.yaml index cba03410..b44ecd1f 100644 --- a/otc_metadata/data/documents/dc-api-ref.yaml +++ b/otc_metadata/data/documents/dc-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dc html_location: docs/dc/api-ref link: /direct-connect/api-ref/ -pdf_name: dc-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dc title: API Reference diff --git a/otc_metadata/data/documents/dc-best-practice.yaml b/otc_metadata/data/documents/dc-best-practice.yaml index f5ecfe6b..3805c9e4 100644 --- a/otc_metadata/data/documents/dc-best-practice.yaml +++ b/otc_metadata/data/documents/dc-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/dc environment: internal html_location: docs/dc/best-practice link: /direct-connect/best-practice/ -pdf_name: dc-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: dc title: Best Practice diff --git a/otc_metadata/data/documents/dc-umn.yaml b/otc_metadata/data/documents/dc-umn.yaml index f32871ae..966f7e89 100644 --- a/otc_metadata/data/documents/dc-umn.yaml +++ b/otc_metadata/data/documents/dc-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dc html_location: docs/dc/umn link: /direct-connect/umn/ -pdf_name: dc-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dc title: User Guide diff --git a/otc_metadata/data/documents/dcs-api-ref.yaml b/otc_metadata/data/documents/dcs-api-ref.yaml index c5ab575c..a1870777 100644 --- a/otc_metadata/data/documents/dcs-api-ref.yaml +++ b/otc_metadata/data/documents/dcs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dcs html_location: docs/dcs/api-ref link: /distributed-cache-service/api-ref/ -pdf_name: dcs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dcs title: API Reference diff --git a/otc_metadata/data/documents/dcs-best-practice.yaml b/otc_metadata/data/documents/dcs-best-practice.yaml index 36a04252..e007f2b1 100644 --- a/otc_metadata/data/documents/dcs-best-practice.yaml +++ b/otc_metadata/data/documents/dcs-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/dcs environment: internal html_location: docs/dcs/best-practice link: /distributed-cache-service/best-practice/ -pdf_name: dcs-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: dcs title: Best Practice diff --git a/otc_metadata/data/documents/dcs-umn.yaml b/otc_metadata/data/documents/dcs-umn.yaml index 472465f9..fbdea84f 100644 --- a/otc_metadata/data/documents/dcs-umn.yaml +++ b/otc_metadata/data/documents/dcs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dcs html_location: docs/dcs/umn link: /distributed-cache-service/umn/ -pdf_name: dcs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dcs title: User Guide diff --git a/otc_metadata/data/documents/ddm-api-ref.yaml b/otc_metadata/data/documents/ddm-api-ref.yaml index 9c082475..4571e154 100644 --- a/otc_metadata/data/documents/ddm-api-ref.yaml +++ b/otc_metadata/data/documents/ddm-api-ref.yaml @@ -3,7 +3,8 @@ hc_location: api/ddm environment: public html_location: docs/ddm/api-ref link: /distributed-database-middleware/api-ref/ -pdf_name: ddm-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: ddm title: API Reference diff --git a/otc_metadata/data/documents/ddm-umn.yaml b/otc_metadata/data/documents/ddm-umn.yaml index 4e7c3f13..4d51faa3 100644 --- a/otc_metadata/data/documents/ddm-umn.yaml +++ b/otc_metadata/data/documents/ddm-umn.yaml @@ -3,7 +3,8 @@ hc_location: usermanual/ddm environment: public html_location: docs/ddm/umn link: /distributed-database-middleware/umn/ -pdf_name: ddm-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: ddm title: User Guide diff --git a/otc_metadata/data/documents/dds-api-ref.yaml b/otc_metadata/data/documents/dds-api-ref.yaml index 46165e33..84b68892 100644 --- a/otc_metadata/data/documents/dds-api-ref.yaml +++ b/otc_metadata/data/documents/dds-api-ref.yaml @@ -2,6 +2,8 @@ hc_location: api/dds html_location: docs/dds/api-ref link: /document-database-service/api-ref/ +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dds title: API Reference diff --git a/otc_metadata/data/documents/dds-best-practice.yaml b/otc_metadata/data/documents/dds-best-practice.yaml index 2eb38ba3..0d4da558 100644 --- a/otc_metadata/data/documents/dds-best-practice.yaml +++ b/otc_metadata/data/documents/dds-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/dds environment: internal html_location: docs/dds/best-practice link: /document-database-service/best-practice/ -pdf_name: dds-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: dds title: Best Practice diff --git a/otc_metadata/data/documents/dds-umn.yaml b/otc_metadata/data/documents/dds-umn.yaml index 3255042e..e682051c 100644 --- a/otc_metadata/data/documents/dds-umn.yaml +++ b/otc_metadata/data/documents/dds-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dds html_location: docs/dds/umn link: /document-database-service/umn/ -pdf_name: dds-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dds title: User Guide diff --git a/otc_metadata/data/documents/deh-api-ref.yaml b/otc_metadata/data/documents/deh-api-ref.yaml index f3e08ade..cf7b5600 100644 --- a/otc_metadata/data/documents/deh-api-ref.yaml +++ b/otc_metadata/data/documents/deh-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/deh html_location: docs/deh/api-ref link: /dedicated-host/api-ref/ -pdf_name: deh-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: deh title: API Reference diff --git a/otc_metadata/data/documents/deh-umn.yaml b/otc_metadata/data/documents/deh-umn.yaml index aff87fdc..e4ecd095 100644 --- a/otc_metadata/data/documents/deh-umn.yaml +++ b/otc_metadata/data/documents/deh-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/deh html_location: docs/deh/umn link: /dedicated-host/umn/ -pdf_name: deh-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: deh title: User Guide diff --git a/otc_metadata/data/documents/dis-api-ref.yaml b/otc_metadata/data/documents/dis-api-ref.yaml index 3d8d92cd..9d2c9f5d 100644 --- a/otc_metadata/data/documents/dis-api-ref.yaml +++ b/otc_metadata/data/documents/dis-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dis html_location: docs/dis/api-ref link: /data-ingestion-service/api-ref/ -pdf_name: dis-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dis title: API Reference diff --git a/otc_metadata/data/documents/dis-umn.yaml b/otc_metadata/data/documents/dis-umn.yaml index ccaabe45..31a010ec 100644 --- a/otc_metadata/data/documents/dis-umn.yaml +++ b/otc_metadata/data/documents/dis-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dis html_location: docs/dis/umn link: /data-ingestion-service/umn/ -pdf_name: dis-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dis title: User Guide diff --git a/otc_metadata/data/documents/dli-api-ref.yaml b/otc_metadata/data/documents/dli-api-ref.yaml index f427ff71..7a7a6dad 100644 --- a/otc_metadata/data/documents/dli-api-ref.yaml +++ b/otc_metadata/data/documents/dli-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dli html_location: docs/dli/api-ref link: /data-lake-insight/api-ref/ -pdf_name: dli-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dli title: API Reference diff --git a/otc_metadata/data/documents/dli-dev.yaml b/otc_metadata/data/documents/dli-dev.yaml index c635dc1d..20e7e461 100644 --- a/otc_metadata/data/documents/dli-dev.yaml +++ b/otc_metadata/data/documents/dli-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/dli html_location: docs/dli/dev link: /data-lake-insight/dev-guide/ -pdf_name: dli-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: dli title: Developer Guide diff --git a/otc_metadata/data/documents/dli-sqlreference.yaml b/otc_metadata/data/documents/dli-sqlreference.yaml index de1ffab2..55dd1d9d 100644 --- a/otc_metadata/data/documents/dli-sqlreference.yaml +++ b/otc_metadata/data/documents/dli-sqlreference.yaml @@ -2,7 +2,8 @@ hc_location: sqlreference/dli html_location: docs/dli/sqlreference link: /data-lake-insight/sqlreference/ -pdf_name: dli-sqlreference +pdf_enabled: true +pdf_environment: public rst_location: doc/sqlreference/source service_type: dli title: Sql Syntax Reference diff --git a/otc_metadata/data/documents/dli-umn.yaml b/otc_metadata/data/documents/dli-umn.yaml index 8ae00cb8..f55cb47c 100644 --- a/otc_metadata/data/documents/dli-umn.yaml +++ b/otc_metadata/data/documents/dli-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dli html_location: docs/dli/umn link: /data-lake-insight/umn/ -pdf_name: dli-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dli title: User Guide diff --git a/otc_metadata/data/documents/dms-api-ref.yaml b/otc_metadata/data/documents/dms-api-ref.yaml index c3ec1006..4b78c42b 100644 --- a/otc_metadata/data/documents/dms-api-ref.yaml +++ b/otc_metadata/data/documents/dms-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dms html_location: docs/dms/api-ref link: /distributed-message-service/api-ref/ -pdf_name: dms-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dms title: API Reference diff --git a/otc_metadata/data/documents/dms-best-practice.yaml b/otc_metadata/data/documents/dms-best-practice.yaml index 484892e9..e0792bff 100644 --- a/otc_metadata/data/documents/dms-best-practice.yaml +++ b/otc_metadata/data/documents/dms-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/dms environment: internal html_location: docs/dms/best-practice link: /distributed-message-service/best-practice/ -pdf_name: dms-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: dms title: Best Practice diff --git a/otc_metadata/data/documents/dms-dev.yaml b/otc_metadata/data/documents/dms-dev.yaml index 6b2390b3..8249687c 100644 --- a/otc_metadata/data/documents/dms-dev.yaml +++ b/otc_metadata/data/documents/dms-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/dms html_location: docs/dms/dev link: /distributed-message-service/dev-guide/ -pdf_name: dms-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: dms title: Developer Guide diff --git a/otc_metadata/data/documents/dms-umn.yaml b/otc_metadata/data/documents/dms-umn.yaml index ce709abb..32c08bc9 100644 --- a/otc_metadata/data/documents/dms-umn.yaml +++ b/otc_metadata/data/documents/dms-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dms html_location: docs/dms/umn link: /distributed-message-service/umn/ -pdf_name: dms-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dms title: User Guide diff --git a/otc_metadata/data/documents/dns-api-ref.yaml b/otc_metadata/data/documents/dns-api-ref.yaml index ce29abd3..58cd3a5b 100644 --- a/otc_metadata/data/documents/dns-api-ref.yaml +++ b/otc_metadata/data/documents/dns-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dns html_location: docs/dns/api-ref link: /domain-name-service/api-ref/ -pdf_name: dns-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dns title: API Reference diff --git a/otc_metadata/data/documents/dns-best-practice.yaml b/otc_metadata/data/documents/dns-best-practice.yaml index e7371805..8cd91d26 100644 --- a/otc_metadata/data/documents/dns-best-practice.yaml +++ b/otc_metadata/data/documents/dns-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/dns environment: internal html_location: docs/dns/best-practice link: /domain-name-service/best-practice/ -pdf_name: dns-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: dns title: Best Practice diff --git a/otc_metadata/data/documents/dns-umn.yaml b/otc_metadata/data/documents/dns-umn.yaml index f00ffd11..55128608 100644 --- a/otc_metadata/data/documents/dns-umn.yaml +++ b/otc_metadata/data/documents/dns-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dns html_location: docs/dns/umn link: /domain-name-service/umn/ -pdf_name: dns-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dns title: User Guide diff --git a/otc_metadata/data/documents/drs-api-ref.yaml b/otc_metadata/data/documents/drs-api-ref.yaml index 29e1f99a..526c0011 100644 --- a/otc_metadata/data/documents/drs-api-ref.yaml +++ b/otc_metadata/data/documents/drs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/drs html_location: docs/drs/api-ref link: /data-replication-service/api-ref/ -pdf_name: drs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: drs title: API Reference diff --git a/otc_metadata/data/documents/drs-best-practice.yaml b/otc_metadata/data/documents/drs-best-practice.yaml index 9181a850..2046347c 100644 --- a/otc_metadata/data/documents/drs-best-practice.yaml +++ b/otc_metadata/data/documents/drs-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/drs environment: internal html_location: docs/drs/best-practice link: /data-replication-service/best-practice/ -pdf_name: drs-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: drs title: Best Practice diff --git a/otc_metadata/data/documents/drs-umn.yaml b/otc_metadata/data/documents/drs-umn.yaml index 710aa172..8b879619 100644 --- a/otc_metadata/data/documents/drs-umn.yaml +++ b/otc_metadata/data/documents/drs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/drs html_location: docs/drs/umn link: /data-replication-service/umn/ -pdf_name: drs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: drs title: User Guide diff --git a/otc_metadata/data/documents/dws-api-ref.yaml b/otc_metadata/data/documents/dws-api-ref.yaml index 48d7a1ff..85b132e7 100644 --- a/otc_metadata/data/documents/dws-api-ref.yaml +++ b/otc_metadata/data/documents/dws-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dws html_location: docs/dws/api-ref link: /data-warehouse-service/api-ref/ -pdf_name: dws-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: dws title: API Reference diff --git a/otc_metadata/data/documents/dws-dev.yaml b/otc_metadata/data/documents/dws-dev.yaml index fb38e91b..2c1c8848 100644 --- a/otc_metadata/data/documents/dws-dev.yaml +++ b/otc_metadata/data/documents/dws-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/dws html_location: docs/dws/dev link: /data-warehouse-service/dev-guide/ -pdf_name: dws-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: dws title: Developer Guide diff --git a/otc_metadata/data/documents/dws-tool-guide.yaml b/otc_metadata/data/documents/dws-tool-guide.yaml index 67576f0d..2449a59a 100644 --- a/otc_metadata/data/documents/dws-tool-guide.yaml +++ b/otc_metadata/data/documents/dws-tool-guide.yaml @@ -2,7 +2,8 @@ hc_location: tg/dws html_location: docs/dws/tool link: /data-warehouse-service/tool-guide/ -pdf_name: dws-tool-guide +pdf_enabled: true +pdf_environment: public rst_location: doc/tool/source service_type: dws title: Tool Guide diff --git a/otc_metadata/data/documents/dws-umn.yaml b/otc_metadata/data/documents/dws-umn.yaml index 45b14b26..af7ed538 100644 --- a/otc_metadata/data/documents/dws-umn.yaml +++ b/otc_metadata/data/documents/dws-umn.yaml @@ -2,6 +2,8 @@ hc_location: usermanual/dws html_location: docs/dws/umn link: /data-warehouse-service/umn/ +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: dws title: User Guide diff --git a/otc_metadata/data/documents/ecs-api-ref.yaml b/otc_metadata/data/documents/ecs-api-ref.yaml index e1aab606..a5dfc306 100644 --- a/otc_metadata/data/documents/ecs-api-ref.yaml +++ b/otc_metadata/data/documents/ecs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/ecs html_location: docs/ecs/api-ref link: /elastic-cloud-server/api-ref/ -pdf_name: ecs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: ecs title: API Reference diff --git a/otc_metadata/data/documents/ecs-best-practice.yaml b/otc_metadata/data/documents/ecs-best-practice.yaml index 9943d728..36444693 100644 --- a/otc_metadata/data/documents/ecs-best-practice.yaml +++ b/otc_metadata/data/documents/ecs-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/ecs environment: internal html_location: docs/ecs/best-practice link: /elastic-cloud-server/best-practice/ -pdf_name: ecs-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: ecs title: Best Practice diff --git a/otc_metadata/data/documents/ecs-dev.yaml b/otc_metadata/data/documents/ecs-dev.yaml index 9c3bf01b..41d15e50 100644 --- a/otc_metadata/data/documents/ecs-dev.yaml +++ b/otc_metadata/data/documents/ecs-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/ecs html_location: docs/ecs/dev link: /elastic-cloud-server/dev-guide/ -pdf_name: ecs-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: ecs title: Developer Guide diff --git a/otc_metadata/data/documents/ecs-umn.yaml b/otc_metadata/data/documents/ecs-umn.yaml index 698496f3..74b76763 100644 --- a/otc_metadata/data/documents/ecs-umn.yaml +++ b/otc_metadata/data/documents/ecs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/ecs html_location: docs/ecs/umn link: /elastic-cloud-server/umn/ -pdf_name: ecs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: ecs title: User Guide diff --git a/otc_metadata/data/documents/ed-api-ref.yaml b/otc_metadata/data/documents/ed-api-ref.yaml index e56c6e94..5b3119f6 100644 --- a/otc_metadata/data/documents/ed-api-ref.yaml +++ b/otc_metadata/data/documents/ed-api-ref.yaml @@ -1,6 +1,8 @@ --- link: /enterprise-dashboard/api-ref/ rst_location: api-ref/source +pdf_enabled: false +pdf_environment: public service_type: ed title: API Reference type: api-ref diff --git a/otc_metadata/data/documents/ed-umn.yaml b/otc_metadata/data/documents/ed-umn.yaml index 2cc66f77..d99b8e69 100644 --- a/otc_metadata/data/documents/ed-umn.yaml +++ b/otc_metadata/data/documents/ed-umn.yaml @@ -1,6 +1,8 @@ --- link: /enterprise-dashboard/umn/ rst_location: umn/source +pdf_enabled: false +pdf_environment: public service_type: ed title: User Guide type: umn diff --git a/otc_metadata/data/documents/eip-api-ref.yaml b/otc_metadata/data/documents/eip-api-ref.yaml index 6732ef07..319975aa 100644 --- a/otc_metadata/data/documents/eip-api-ref.yaml +++ b/otc_metadata/data/documents/eip-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/eip html_location: docs/eip/api-ref link: /elastic-ip/api-ref/ -pdf_name: eip-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: eip title: API Reference diff --git a/otc_metadata/data/documents/eip-umn.yaml b/otc_metadata/data/documents/eip-umn.yaml index 92178d74..b9f2df10 100644 --- a/otc_metadata/data/documents/eip-umn.yaml +++ b/otc_metadata/data/documents/eip-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/eip html_location: docs/eip/umn link: /elastic-ip/umn/ -pdf_name: eip-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: eip title: User Guide diff --git a/otc_metadata/data/documents/elb-api-ref.yaml b/otc_metadata/data/documents/elb-api-ref.yaml index a58f5f67..5fc3faec 100644 --- a/otc_metadata/data/documents/elb-api-ref.yaml +++ b/otc_metadata/data/documents/elb-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/elb html_location: docs/elb/api-ref link: /elastic-load-balancing/api-ref/ -pdf_name: elb-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: elb title: API Reference diff --git a/otc_metadata/data/documents/elb-best-practice.yaml b/otc_metadata/data/documents/elb-best-practice.yaml index 13814b58..eefbc4f3 100644 --- a/otc_metadata/data/documents/elb-best-practice.yaml +++ b/otc_metadata/data/documents/elb-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/elb environment: internal html_location: docs/elb/best-practice link: /elastic-load-balancing/best-practice/ -pdf_name: elb-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: elb title: Best Practice diff --git a/otc_metadata/data/documents/elb-umn.yaml b/otc_metadata/data/documents/elb-umn.yaml index 6a0b762c..02e41edc 100644 --- a/otc_metadata/data/documents/elb-umn.yaml +++ b/otc_metadata/data/documents/elb-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/elb html_location: docs/elb/umn link: /elastic-load-balancing/umn/ -pdf_name: elb-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: elb title: User Guide diff --git a/otc_metadata/data/documents/eps-api-ref.yaml b/otc_metadata/data/documents/eps-api-ref.yaml new file mode 100644 index 00000000..f00dbbc6 --- /dev/null +++ b/otc_metadata/data/documents/eps-api-ref.yaml @@ -0,0 +1,12 @@ +--- +environment: internal +hc_location: api/em +html_location: docs/eps/api-ref +link: /enterprise-project-service/api-ref/ +pdf_enabled: true +pdf_environment: public +rst_location: api-ref/source +service_type: eps +title: API Reference +type: api-ref + diff --git a/otc_metadata/data/documents/eps-umn.yaml b/otc_metadata/data/documents/eps-umn.yaml new file mode 100644 index 00000000..32458da8 --- /dev/null +++ b/otc_metadata/data/documents/eps-umn.yaml @@ -0,0 +1,12 @@ +--- +environment: internal +hc_location: usermanual/em +html_location: docs/eps/umn +link: /enterprise-project-service/umn/ +pdf_enabled: true +pdf_environment: public +rst_location: umn/source +service_type: eps +title: User Guide +type: umn + diff --git a/otc_metadata/data/documents/er-api-ref.yaml b/otc_metadata/data/documents/er-api-ref.yaml index 5408aeda..3f6e97ad 100644 --- a/otc_metadata/data/documents/er-api-ref.yaml +++ b/otc_metadata/data/documents/er-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/er html_location: docs/er/api-ref link: /enterprise-router/api-ref/ -pdf_name: er-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: er title: API Reference diff --git a/otc_metadata/data/documents/er-umn.yaml b/otc_metadata/data/documents/er-umn.yaml index b71ffb7a..5f3f61ae 100644 --- a/otc_metadata/data/documents/er-umn.yaml +++ b/otc_metadata/data/documents/er-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/er html_location: docs/er/umn link: /enterprise-router/umn/ -pdf_name: er-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: er title: User Guide diff --git a/otc_metadata/data/documents/evs-api-ref.yaml b/otc_metadata/data/documents/evs-api-ref.yaml index 13f69866..84a121da 100644 --- a/otc_metadata/data/documents/evs-api-ref.yaml +++ b/otc_metadata/data/documents/evs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/evs html_location: docs/evs/api-ref link: /elastic-volume-service/api-ref/ -pdf_name: evs-api-ref +pdf_enabled: false +pdf_environment: public rst_location: api-ref/source service_type: evs title: API Reference diff --git a/otc_metadata/data/documents/evs-best-practice.yaml b/otc_metadata/data/documents/evs-best-practice.yaml index b0fbdee6..7214c7f6 100644 --- a/otc_metadata/data/documents/evs-best-practice.yaml +++ b/otc_metadata/data/documents/evs-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/evs environment: internal html_location: docs/evs/best-practice link: /elastic-volume-service/best-practice/ -pdf_name: evs-best-practice +pdf_enabled: false +pdf_environment: public rst_location: doc/best-practice/source service_type: evs title: Best Practice diff --git a/otc_metadata/data/documents/evs-dev.yaml b/otc_metadata/data/documents/evs-dev.yaml index 4e6b7b15..f3e4d26b 100644 --- a/otc_metadata/data/documents/evs-dev.yaml +++ b/otc_metadata/data/documents/evs-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/evs html_location: docs/evs/dev link: /elastic-volume-service/dev-guide/ -pdf_name: evs-dev-guide +pdf_enabled: false +pdf_environment: public rst_location: dev_guide/source service_type: evs title: Developer Guide diff --git a/otc_metadata/data/documents/evs-umn.yaml b/otc_metadata/data/documents/evs-umn.yaml index 79f95f66..1a7ee49d 100644 --- a/otc_metadata/data/documents/evs-umn.yaml +++ b/otc_metadata/data/documents/evs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/evs html_location: docs/evs/umn link: /elastic-volume-service/umn/ -pdf_name: evs-umn +pdf_enabled: false +pdf_environment: public rst_location: umn/source service_type: evs title: User Guide diff --git a/otc_metadata/data/documents/fg-api-ref.yaml b/otc_metadata/data/documents/fg-api-ref.yaml index 99f7c3be..0cc66d3e 100644 --- a/otc_metadata/data/documents/fg-api-ref.yaml +++ b/otc_metadata/data/documents/fg-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/functiongraph html_location: docs/fg/api-ref link: /function-graph/api-ref/ -pdf_name: fg-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: fg title: API Reference diff --git a/otc_metadata/data/documents/fg-best-practice.yaml b/otc_metadata/data/documents/fg-best-practice.yaml index 416f94b9..40f34e2f 100644 --- a/otc_metadata/data/documents/fg-best-practice.yaml +++ b/otc_metadata/data/documents/fg-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/functiongraph environment: internal html_location: docs/fg/best-practice link: /function-graph/best-practice/ -pdf_name: fg-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: fg title: Best Practice diff --git a/otc_metadata/data/documents/fg-dev.yaml b/otc_metadata/data/documents/fg-dev.yaml index 8a7b568b..f4ec48cb 100644 --- a/otc_metadata/data/documents/fg-dev.yaml +++ b/otc_metadata/data/documents/fg-dev.yaml @@ -3,7 +3,8 @@ hc_location: devg/functiongraph environment: internal html_location: docs/fg/dev link: /function-graph/dev-guide/ -pdf_name: fg-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: fg title: Developer Guide diff --git a/otc_metadata/data/documents/fg-umn.yaml b/otc_metadata/data/documents/fg-umn.yaml index 6ffafb2e..07d7d283 100644 --- a/otc_metadata/data/documents/fg-umn.yaml +++ b/otc_metadata/data/documents/fg-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/functiongraph html_location: docs/fg/umn link: /function-graph/umn/ -pdf_name: fg-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: fg title: User Guide diff --git a/otc_metadata/data/documents/gaussdb_mysql-api-ref.yaml b/otc_metadata/data/documents/gaussdb_mysql-api-ref.yaml index 05d4f569..65a3568d 100644 --- a/otc_metadata/data/documents/gaussdb_mysql-api-ref.yaml +++ b/otc_metadata/data/documents/gaussdb_mysql-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/gaussdb html_location: docs/gaussdb_mysql/api-ref link: /gaussdb-mysql/api-ref/ -pdf_name: gaussdb_mysql-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: gaussdb_mysql title: API Reference diff --git a/otc_metadata/data/documents/gaussdb_mysql-umn.yaml b/otc_metadata/data/documents/gaussdb_mysql-umn.yaml index 80fef845..56be5295 100644 --- a/otc_metadata/data/documents/gaussdb_mysql-umn.yaml +++ b/otc_metadata/data/documents/gaussdb_mysql-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/gaussdb html_location: docs/gaussdb_mysql/umn link: /gaussdb-mysql/umn/ -pdf_name: gaussdb_mysql-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: gaussdb_mysql title: User Guide diff --git a/otc_metadata/data/documents/gaussdb_nosql-api-ref.yaml b/otc_metadata/data/documents/gaussdb_nosql-api-ref.yaml deleted file mode 100644 index 4706e2e6..00000000 --- a/otc_metadata/data/documents/gaussdb_nosql-api-ref.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -hc_location: api/nosql -html_location: docs/gaussdb_nosql/api-ref -link: /gaussdb-nosql/api-ref/ -pdf_name: gaussdb_nosql-api-ref -rst_location: api-ref/source -service_type: gaussdb_nosql -title: API Reference -type: api-ref diff --git a/otc_metadata/data/documents/gaussdb_nosql-umn.yaml b/otc_metadata/data/documents/gaussdb_nosql-umn.yaml deleted file mode 100644 index 3e5a6985..00000000 --- a/otc_metadata/data/documents/gaussdb_nosql-umn.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -hc_location: usermanual/nosql -html_location: docs/gaussdb_nosql/umn -link: /gaussdb-nosql/umn/ -pdf_name: gauss_nosql -rst_location: umn/source -service_type: gaussdb_nosql -title: User Guide -type: umn diff --git a/otc_metadata/data/documents/geminidb-api-ref.yaml b/otc_metadata/data/documents/geminidb-api-ref.yaml index cbeb4256..9ff9e044 100644 --- a/otc_metadata/data/documents/geminidb-api-ref.yaml +++ b/otc_metadata/data/documents/geminidb-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/nosql html_location: docs/geminidb/api-ref link: /geminidb/api-ref/ -pdf_name: geminidb-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: geminidb title: API Reference diff --git a/otc_metadata/data/documents/geminidb-umn.yaml b/otc_metadata/data/documents/geminidb-umn.yaml index 718f0f2c..3b5bd0b9 100644 --- a/otc_metadata/data/documents/geminidb-umn.yaml +++ b/otc_metadata/data/documents/geminidb-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/nosql html_location: docs/geminidb/umn link: /geminidb/umn/ -pdf_name: geminidb-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: geminidb title: User Guide diff --git a/otc_metadata/data/documents/hss-api-ref.yaml b/otc_metadata/data/documents/hss-api-ref.yaml index fc3f2df6..c6a776d1 100644 --- a/otc_metadata/data/documents/hss-api-ref.yaml +++ b/otc_metadata/data/documents/hss-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/hss2.0 html_location: docs/hss/api-ref link: /host-security-service/api-ref/ -pdf_name: hss-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: hss title: API Reference diff --git a/otc_metadata/data/documents/hss-umn.yaml b/otc_metadata/data/documents/hss-umn.yaml index fc40b742..3e8a56ae 100644 --- a/otc_metadata/data/documents/hss-umn.yaml +++ b/otc_metadata/data/documents/hss-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/hss2.0 html_location: docs/hss/umn link: /host-security-service/umn/ -pdf_name: hss-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: hss title: User Guide diff --git a/otc_metadata/data/documents/iam-api-ref.yaml b/otc_metadata/data/documents/iam-api-ref.yaml index 4b0cf652..d64c8229 100644 --- a/otc_metadata/data/documents/iam-api-ref.yaml +++ b/otc_metadata/data/documents/iam-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/iam html_location: docs/iam/api-ref link: /identity-access-management/api-ref/ -pdf_name: iam-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: iam title: API Reference diff --git a/otc_metadata/data/documents/iam-best-practice.yaml b/otc_metadata/data/documents/iam-best-practice.yaml index 35b37f7e..1def988b 100644 --- a/otc_metadata/data/documents/iam-best-practice.yaml +++ b/otc_metadata/data/documents/iam-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/iam environment: internal html_location: docs/iam/best-practice link: /identity-access-management/best-practice/ -pdf_name: iam-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: iam title: Best Practice diff --git a/otc_metadata/data/documents/iam-mycredential.yaml b/otc_metadata/data/documents/iam-mycredential.yaml index 5e72d32c..abe6d304 100644 --- a/otc_metadata/data/documents/iam-mycredential.yaml +++ b/otc_metadata/data/documents/iam-mycredential.yaml @@ -1,7 +1,8 @@ --- hc_location: usermanual/ac link: /identity-access-management/mycredential/ -pdf_name: iam-mycredential-guide +pdf_enabled: true +pdf_environment: public rst_location: doc/mycredential/source service_type: iam title: My Credential diff --git a/otc_metadata/data/documents/iam-permissions.yaml b/otc_metadata/data/documents/iam-permissions.yaml index 7de39355..bd2ee3c5 100644 --- a/otc_metadata/data/documents/iam-permissions.yaml +++ b/otc_metadata/data/documents/iam-permissions.yaml @@ -3,7 +3,8 @@ hc_location: permissions environment: internal html_location: docs/iam/permissions link: /identity-access-management/permissions/ -pdf_name: iam-permissions +pdf_enabled: true +pdf_environment: public rst_location: doc/permissions/source service_type: iam title: Permissions diff --git a/otc_metadata/data/documents/iam-umn.yaml b/otc_metadata/data/documents/iam-umn.yaml index b6bd99ca..c20258ca 100644 --- a/otc_metadata/data/documents/iam-umn.yaml +++ b/otc_metadata/data/documents/iam-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/iam html_location: docs/iam/umn link: /identity-access-management/umn/ -pdf_name: iam-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: iam title: User Guide diff --git a/otc_metadata/data/documents/ims-api-ref.yaml b/otc_metadata/data/documents/ims-api-ref.yaml index e45f8e94..ef8c8e68 100644 --- a/otc_metadata/data/documents/ims-api-ref.yaml +++ b/otc_metadata/data/documents/ims-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/ims html_location: docs/ims/api-ref link: /image-management-service/api-ref/ -pdf_name: ims-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: ims title: API Reference diff --git a/otc_metadata/data/documents/ims-best-practice.yaml b/otc_metadata/data/documents/ims-best-practice.yaml index d54c90aa..780fa311 100644 --- a/otc_metadata/data/documents/ims-best-practice.yaml +++ b/otc_metadata/data/documents/ims-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/ims environment: internal html_location: docs/ims/best-practice link: /image-management-service/best-practice/ -pdf_name: ims-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: ims title: Best Practice diff --git a/otc_metadata/data/documents/ims-dev.yaml b/otc_metadata/data/documents/ims-dev.yaml index 5bf2269e..7c7ca373 100644 --- a/otc_metadata/data/documents/ims-dev.yaml +++ b/otc_metadata/data/documents/ims-dev.yaml @@ -2,7 +2,8 @@ hc_location: devg/ims html_location: docs/ims/dev link: /image-management-service/dev-guide/ -pdf_name: ims-dev-guide +pdf_enabled: true +pdf_environment: public rst_location: dev_guide/source service_type: ims title: Developer Guide diff --git a/otc_metadata/data/documents/ims-public-images.yaml b/otc_metadata/data/documents/ims-public-images.yaml index b6074334..0c78a22c 100644 --- a/otc_metadata/data/documents/ims-public-images.yaml +++ b/otc_metadata/data/documents/ims-public-images.yaml @@ -1,7 +1,8 @@ --- environment: public link: /image-management-service/public-images/ -pdf_name: ims-public-images +pdf_enabled: true +pdf_environment: public rst_location: doc/public-images/source service_type: ims title: Public Image Introduction diff --git a/otc_metadata/data/documents/ims-umn.yaml b/otc_metadata/data/documents/ims-umn.yaml index cb863938..dd55b2b9 100644 --- a/otc_metadata/data/documents/ims-umn.yaml +++ b/otc_metadata/data/documents/ims-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/ims html_location: docs/ims/umn link: /image-management-service/umn/ -pdf_name: ims-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: ims title: User Guide diff --git a/otc_metadata/data/documents/kms-api-ref.yaml b/otc_metadata/data/documents/kms-api-ref.yaml index a00e7509..e0d0261e 100644 --- a/otc_metadata/data/documents/kms-api-ref.yaml +++ b/otc_metadata/data/documents/kms-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/kms html_location: docs/kms/api-ref link: /key-management-service/api-ref/ -pdf_name: kms-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: kms title: API Reference diff --git a/otc_metadata/data/documents/kms-umn.yaml b/otc_metadata/data/documents/kms-umn.yaml index fe7bf1e2..0eada277 100644 --- a/otc_metadata/data/documents/kms-umn.yaml +++ b/otc_metadata/data/documents/kms-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/kms html_location: docs/kms/umn link: /key-management-service/umn/ -pdf_name: kms-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: kms title: User Guide diff --git a/otc_metadata/data/documents/lts-api-ref.yaml b/otc_metadata/data/documents/lts-api-ref.yaml index 7ae04a0d..8fcc26f0 100644 --- a/otc_metadata/data/documents/lts-api-ref.yaml +++ b/otc_metadata/data/documents/lts-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/lts html_location: docs/lts/api-ref link: /log-tank-service/api-ref/ -pdf_name: lts-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: lts title: API Reference diff --git a/otc_metadata/data/documents/lts-umn.yaml b/otc_metadata/data/documents/lts-umn.yaml index a31d8895..62a7c8ba 100644 --- a/otc_metadata/data/documents/lts-umn.yaml +++ b/otc_metadata/data/documents/lts-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/lts html_location: docs/lts/umn link: /log-tank-service/umn/ -pdf_name: lts-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: lts title: User Guide diff --git a/otc_metadata/data/documents/ma-api-ref.yaml b/otc_metadata/data/documents/ma-api-ref.yaml index 47786acc..1a2658f8 100644 --- a/otc_metadata/data/documents/ma-api-ref.yaml +++ b/otc_metadata/data/documents/ma-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/modelarts html_location: docs/modelarts/api-ref link: /modelarts/api-ref/ -pdf_name: ma-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: ma title: API Reference diff --git a/otc_metadata/data/documents/ma-sdk-ref.yaml b/otc_metadata/data/documents/ma-sdk-ref.yaml index bc5abbf3..d9e5c252 100644 --- a/otc_metadata/data/documents/ma-sdk-ref.yaml +++ b/otc_metadata/data/documents/ma-sdk-ref.yaml @@ -2,7 +2,8 @@ hc_location: sdk/modelarts html_location: docs/modelarts/sdk-ref link: /modelarts/sdk-ref/ -pdf_name: ma-sdk-ref +pdf_enabled: true +pdf_environment: public rst_location: doc/sdk-ref/source service_type: ma title: ModelArts Software Development Kit (ModelArts SDK) diff --git a/otc_metadata/data/documents/ma-umn.yaml b/otc_metadata/data/documents/ma-umn.yaml index c81eb86c..f1b834c9 100644 --- a/otc_metadata/data/documents/ma-umn.yaml +++ b/otc_metadata/data/documents/ma-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/modelarts html_location: docs/modelarts/umn link: /modelarts/umn/ -pdf_name: ma-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: ma title: User Guide diff --git a/otc_metadata/data/documents/mkp-umn.yaml b/otc_metadata/data/documents/mkp-umn.yaml index 467fdda7..9e9881b2 100644 --- a/otc_metadata/data/documents/mkp-umn.yaml +++ b/otc_metadata/data/documents/mkp-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/mkp html_location: docs/mkp/umn link: /marketplace/umn/ -pdf_name: mkp-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: mkp title: User Guide diff --git a/otc_metadata/data/documents/mrs-api-ref.yaml b/otc_metadata/data/documents/mrs-api-ref.yaml index 6b78225e..e6f4d2cb 100644 --- a/otc_metadata/data/documents/mrs-api-ref.yaml +++ b/otc_metadata/data/documents/mrs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/mrs html_location: docs/mrs/api-ref link: /mapreduce-service/api-ref/ -pdf_name: mrs-api-ref +pdf_enabled: false +pdf_environment: public rst_location: api-ref/source service_type: mrs title: API Reference diff --git a/otc_metadata/data/documents/mrs-best-practice.yaml b/otc_metadata/data/documents/mrs-best-practice.yaml index ce5187ab..1797b367 100644 --- a/otc_metadata/data/documents/mrs-best-practice.yaml +++ b/otc_metadata/data/documents/mrs-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/mrs environment: internal html_location: docs/mrs/best-practice link: /mapreduce-service/best-practice/ -pdf_name: mrs-best-practice +pdf_enabled: false +pdf_environment: public rst_location: doc/best-practice/source service_type: mrs title: Best Practice diff --git a/otc_metadata/data/documents/mrs-operation-guide-lts.yaml b/otc_metadata/data/documents/mrs-operation-guide-lts.yaml index e9d4bee7..341be894 100644 --- a/otc_metadata/data/documents/mrs-operation-guide-lts.yaml +++ b/otc_metadata/data/documents/mrs-operation-guide-lts.yaml @@ -2,7 +2,8 @@ hc_location: cmpntguide-lts/mrs html_location: docs/mrs/component-operation-guide-lts link: /mapreduce-service/operation-guide-lts/ -pdf_name: mrs-component-operation-guide-lts +pdf_enabled: false +pdf_environment: public rst_location: doc/component-operation-guide-lts/source service_type: mrs title: Component Operation Guide (LTS) diff --git a/otc_metadata/data/documents/mrs-operation-guide.yaml b/otc_metadata/data/documents/mrs-operation-guide.yaml index 08a09a96..63cea76a 100644 --- a/otc_metadata/data/documents/mrs-operation-guide.yaml +++ b/otc_metadata/data/documents/mrs-operation-guide.yaml @@ -2,7 +2,8 @@ hc_location: cmpntguide/mrs html_location: docs/mrs/component-operation-guide link: /mapreduce-service/operation-guide/ -pdf_name: mrs-component-operation-guide +pdf_enabled: false +pdf_environment: public rst_location: doc/component-operation-guide/source service_type: mrs title: Component Operation Guide diff --git a/otc_metadata/data/documents/mrs-umn.yaml b/otc_metadata/data/documents/mrs-umn.yaml index 7acaca55..aaaaf927 100644 --- a/otc_metadata/data/documents/mrs-umn.yaml +++ b/otc_metadata/data/documents/mrs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/mrs html_location: docs/mrs/umn link: /mapreduce-service/umn/ -pdf_name: mrs-umn +pdf_enabled: false +pdf_environment: public rst_location: umn/source service_type: mrs title: User Guide diff --git a/otc_metadata/data/documents/natgw-api-ref.yaml b/otc_metadata/data/documents/natgw-api-ref.yaml index 315373e9..50428925 100644 --- a/otc_metadata/data/documents/natgw-api-ref.yaml +++ b/otc_metadata/data/documents/natgw-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/nat html_location: docs/natgw/api-ref link: /nat-gateway/api-ref/ -pdf_name: natgw-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: natgw title: API Reference diff --git a/otc_metadata/data/documents/natgw-best-practice.yaml b/otc_metadata/data/documents/natgw-best-practice.yaml index d9656718..b054c396 100644 --- a/otc_metadata/data/documents/natgw-best-practice.yaml +++ b/otc_metadata/data/documents/natgw-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/natgw environment: internal html_location: docs/natgw/best-practice link: /nat-gateway/best-practice/ -pdf_name: natgw-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: natgw title: Best Practice diff --git a/otc_metadata/data/documents/natgw-umn.yaml b/otc_metadata/data/documents/natgw-umn.yaml index ccb497c2..3f8ea508 100644 --- a/otc_metadata/data/documents/natgw-umn.yaml +++ b/otc_metadata/data/documents/natgw-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/nat html_location: docs/natgw/umn link: /nat-gateway/umn/ -pdf_name: natgw-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: natgw title: User Guide diff --git a/otc_metadata/data/documents/obs-api-ref.yaml b/otc_metadata/data/documents/obs-api-ref.yaml index 7fa9589f..5bc64998 100644 --- a/otc_metadata/data/documents/obs-api-ref.yaml +++ b/otc_metadata/data/documents/obs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/obs html_location: docs/obs/api-ref link: /object-storage-service/api-ref/ -pdf_name: obs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: obs title: API Reference diff --git a/otc_metadata/data/documents/obs-best-practice.yaml b/otc_metadata/data/documents/obs-best-practice.yaml index 86bf89d9..9d51c96f 100644 --- a/otc_metadata/data/documents/obs-best-practice.yaml +++ b/otc_metadata/data/documents/obs-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/obs environment: internal html_location: docs/obs/best-practice link: /object-storage-service/best-practice/ -pdf_name: obs-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: obs title: Best Practice diff --git a/otc_metadata/data/documents/obs-parallel-file-system.yaml b/otc_metadata/data/documents/obs-parallel-file-system.yaml index 59292bb6..1e292321 100644 --- a/otc_metadata/data/documents/obs-parallel-file-system.yaml +++ b/otc_metadata/data/documents/obs-parallel-file-system.yaml @@ -2,7 +2,8 @@ hc_location: pfs/obs html_location: docs/obs/pfs link: /object-storage-service/parallel-file-system/ -pdf_name: obs-pfs +pdf_enabled: true +pdf_environment: public rst_location: doc/parallel-file-system/source service_type: obs title: Parallel File System (PFS) diff --git a/otc_metadata/data/documents/obs-permissions-configuration-guide.yaml b/otc_metadata/data/documents/obs-permissions-configuration-guide.yaml index 2e362804..2462d5e3 100644 --- a/otc_metadata/data/documents/obs-permissions-configuration-guide.yaml +++ b/otc_metadata/data/documents/obs-permissions-configuration-guide.yaml @@ -2,7 +2,8 @@ hc_location: perms-cfg/obs html_location: docs/obs/perms-cfg link: /object-storage-service/permissions-configuration-guide/ -pdf_name: obs-perms-cfg +pdf_enabled: true +pdf_environment: public rst_location: doc/permissions-configuration-guide/source service_type: obs title: Permissions Configuration Guide diff --git a/otc_metadata/data/documents/obs-s3api.yaml b/otc_metadata/data/documents/obs-s3api.yaml index 6116f0f6..3febe94d 100644 --- a/otc_metadata/data/documents/obs-s3api.yaml +++ b/otc_metadata/data/documents/obs-s3api.yaml @@ -2,7 +2,8 @@ hc_location: api_obs/obs html_location: docs/obs/s3api link: /object-storage-service/s3api/ -pdf_name: obs-s3api +pdf_enabled: true +pdf_environment: public rst_location: doc/s3api/source service_type: obs title: S3 API Reference diff --git a/otc_metadata/data/documents/obs-swiftapi.yaml b/otc_metadata/data/documents/obs-swiftapi.yaml deleted file mode 100644 index 138dd093..00000000 --- a/otc_metadata/data/documents/obs-swiftapi.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- -environment: internal -hc_location: api_swift/obs -html_location: docs/obs/api-swift -link: /object-storage-service/swiftapi/ -pdf_name: obs-swiftapi -rst_location: doc/swiftapi/source -service_type: obs -title: API Reference (Swift) - Deprecated - Will be removed at 2023 Nov. 10! -type: swiftapi diff --git a/otc_metadata/data/documents/obs-tool-guide.yaml b/otc_metadata/data/documents/obs-tool-guide.yaml index a8e2e165..fafd2b5b 100644 --- a/otc_metadata/data/documents/obs-tool-guide.yaml +++ b/otc_metadata/data/documents/obs-tool-guide.yaml @@ -2,7 +2,8 @@ hc_location: browsertg/obs html_location: docs/obs/tool link: /object-storage-service/tool-guide/ -pdf_name: obs-tool-guide +pdf_enabled: true +pdf_environment: public rst_location: doc/tool/source service_type: obs title: Tool Guide (OBS Browser) diff --git a/otc_metadata/data/documents/obs-umn.yaml b/otc_metadata/data/documents/obs-umn.yaml index ef103591..53dda5c4 100644 --- a/otc_metadata/data/documents/obs-umn.yaml +++ b/otc_metadata/data/documents/obs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/obs html_location: docs/obs/umn link: /object-storage-service/umn/ -pdf_name: obs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: obs title: User Guide diff --git a/otc_metadata/data/documents/obs_3rd_party-python-sdk.yaml b/otc_metadata/data/documents/obs_3rd_party-python-sdk.yaml new file mode 100644 index 00000000..b0a3bfe8 --- /dev/null +++ b/otc_metadata/data/documents/obs_3rd_party-python-sdk.yaml @@ -0,0 +1,10 @@ +--- +hc_location: sdk/python-devg-obs +html_location: docs/obs_3rd_party/python_sdk +link: /object-storage-service-3rd-party/python-sdk/ +pdf_enabled: false +pdf_environment: public +rst_location: doc/python-sdk/source +service_type: obs_3rd_party +title: Python SDK +type: python-sdk diff --git a/otc_metadata/data/documents/ocr-api-ref.yaml b/otc_metadata/data/documents/ocr-api-ref.yaml index 499d36ea..01b873fd 100644 --- a/otc_metadata/data/documents/ocr-api-ref.yaml +++ b/otc_metadata/data/documents/ocr-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/ocr html_location: docs/ocr/api-ref link: /optical-character-recognition/api-ref/ -pdf_name: ocr-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: ocr title: API Reference diff --git a/otc_metadata/data/documents/ocr-umn.yaml b/otc_metadata/data/documents/ocr-umn.yaml index ac40b067..1464e05c 100644 --- a/otc_metadata/data/documents/ocr-umn.yaml +++ b/otc_metadata/data/documents/ocr-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/ocr html_location: docs/ocr/umn link: /optical-character-recognition/umn/ -pdf_name: ocr-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: ocr title: User Guide diff --git a/otc_metadata/data/documents/opengauss-api-ref.yaml b/otc_metadata/data/documents/opengauss-api-ref.yaml index 2c109a19..718eb96c 100644 --- a/otc_metadata/data/documents/opengauss-api-ref.yaml +++ b/otc_metadata/data/documents/opengauss-api-ref.yaml @@ -3,7 +3,8 @@ environment: internal hc_location: api/opengauss html_location: docs/opengauss/api-ref link: /gaussdb-opengauss/api-ref/ -pdf_name: opengauss-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: opengauss title: API Reference diff --git a/otc_metadata/data/documents/opengauss-umn.yaml b/otc_metadata/data/documents/opengauss-umn.yaml index 615fa0f6..b9a6279c 100644 --- a/otc_metadata/data/documents/opengauss-umn.yaml +++ b/otc_metadata/data/documents/opengauss-umn.yaml @@ -3,7 +3,8 @@ environment: internal hc_location: usermanual/opengauss html_location: docs/opengauss/umn link: /gaussdb-opengauss/umn/ -pdf_name: opengauss-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: opengauss title: User Guide diff --git a/otc_metadata/data/documents/pc-api-ref.yaml b/otc_metadata/data/documents/pc-api-ref.yaml index bcb46483..eecabd6b 100644 --- a/otc_metadata/data/documents/pc-api-ref.yaml +++ b/otc_metadata/data/documents/pc-api-ref.yaml @@ -1,7 +1,7 @@ --- -environment: internal link: /price-calculator/api-ref/ -pdf_name: pc-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: pc title: API Reference diff --git a/otc_metadata/data/documents/plas-api-ref.yaml b/otc_metadata/data/documents/plas-api-ref.yaml index 0560559d..64be0fbe 100644 --- a/otc_metadata/data/documents/plas-api-ref.yaml +++ b/otc_metadata/data/documents/plas-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/plas html_location: docs/plas/api-ref link: /private-link-access-service/api-ref/ -pdf_name: plas-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: plas title: API Reference diff --git a/otc_metadata/data/documents/plas-umn.yaml b/otc_metadata/data/documents/plas-umn.yaml index fd55bc22..5f2c5554 100644 --- a/otc_metadata/data/documents/plas-umn.yaml +++ b/otc_metadata/data/documents/plas-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/plas html_location: docs/plas/umn link: /private-link-access-service/umn/ -pdf_name: plas-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: plas title: User Guide diff --git a/otc_metadata/data/documents/rds-api-ref.yaml b/otc_metadata/data/documents/rds-api-ref.yaml index 6cafe030..d56b8049 100644 --- a/otc_metadata/data/documents/rds-api-ref.yaml +++ b/otc_metadata/data/documents/rds-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/rds html_location: docs/rds/api-ref link: /relational-database-service/api-ref/ -pdf_name: rds-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: rds title: API Reference diff --git a/otc_metadata/data/documents/rds-umn.yaml b/otc_metadata/data/documents/rds-umn.yaml index 769f927d..e9676d75 100644 --- a/otc_metadata/data/documents/rds-umn.yaml +++ b/otc_metadata/data/documents/rds-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/rds html_location: docs/rds/umn link: /relational-database-service/umn/ -pdf_name: rds-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: rds title: User Guide diff --git a/otc_metadata/data/documents/rfs-api-ref.yaml b/otc_metadata/data/documents/rfs-api-ref.yaml index 373d6c5c..9887caea 100644 --- a/otc_metadata/data/documents/rfs-api-ref.yaml +++ b/otc_metadata/data/documents/rfs-api-ref.yaml @@ -1,9 +1,10 @@ --- -hc_location: api/rfs +hc_location: api/aos environment: internal html_location: docs/rfs/api-ref link: /resource-formation-service/api-ref/ -pdf_name: rfs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: rfs title: API Reference diff --git a/otc_metadata/data/documents/rfs-umn.yaml b/otc_metadata/data/documents/rfs-umn.yaml index 668a3bad..5334b539 100644 --- a/otc_metadata/data/documents/rfs-umn.yaml +++ b/otc_metadata/data/documents/rfs-umn.yaml @@ -1,9 +1,10 @@ --- hc_location: usermanual/aos -environment: internal +environment: public html_location: docs/rfs/umn link: /resource-formation-service/umn/ -pdf_name: rfs-umn +pdf_environment: public +pdf_enabled: true rst_location: umn/source service_type: rfs title: User Guide diff --git a/otc_metadata/data/documents/rms-api-ref.yaml b/otc_metadata/data/documents/rms-api-ref.yaml deleted file mode 100644 index d6832938..00000000 --- a/otc_metadata/data/documents/rms-api-ref.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -hc_location: api/rms -html_location: docs/rms/api-ref -link: /resource-management-service/api-ref/ -pdf_name: rms-api-ref -rst_location: api-ref/source -service_type: rms -title: API Reference -type: api-ref diff --git a/otc_metadata/data/documents/rms-umn.yaml b/otc_metadata/data/documents/rms-umn.yaml deleted file mode 100644 index 90624cfa..00000000 --- a/otc_metadata/data/documents/rms-umn.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -hc_location: usermanual/rms -html_location: docs/rms/umn -link: /resource-management-service/umn/ -pdf_name: rms-umn -rst_location: umn/source -service_type: rms -title: User Guide -type: umn diff --git a/otc_metadata/data/documents/sdrs-api-ref.yaml b/otc_metadata/data/documents/sdrs-api-ref.yaml index 56d0e4de..f6abbd9a 100644 --- a/otc_metadata/data/documents/sdrs-api-ref.yaml +++ b/otc_metadata/data/documents/sdrs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/sdrs html_location: docs/sdrs/api-ref link: /storage-disaster-recovery-service/api-ref/ -pdf_name: sdrs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: sdrs title: API Reference diff --git a/otc_metadata/data/documents/sdrs-umn.yaml b/otc_metadata/data/documents/sdrs-umn.yaml index 77ec701b..10e24c37 100644 --- a/otc_metadata/data/documents/sdrs-umn.yaml +++ b/otc_metadata/data/documents/sdrs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/sdrs html_location: docs/sdrs/umn link: /storage-disaster-recovery-service/umn/ -pdf_name: sdrs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: sdrs title: User Guide diff --git a/otc_metadata/data/documents/sfs-api-ref.yaml b/otc_metadata/data/documents/sfs-api-ref.yaml index 03a98612..281e16cd 100644 --- a/otc_metadata/data/documents/sfs-api-ref.yaml +++ b/otc_metadata/data/documents/sfs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/sfs html_location: docs/sfs/api-ref link: /scalable-file-service/api-ref/ -pdf_name: sfs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: sfs title: API Reference diff --git a/otc_metadata/data/documents/sfs-best-practice.yaml b/otc_metadata/data/documents/sfs-best-practice.yaml index 12cd20ca..975770b3 100644 --- a/otc_metadata/data/documents/sfs-best-practice.yaml +++ b/otc_metadata/data/documents/sfs-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/sfs environment: internal html_location: docs/sfs/best-practice link: /scalable-file-service/best-practice/ -pdf_name: sfs-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: sfs title: Best Practice diff --git a/otc_metadata/data/documents/sfs-umn.yaml b/otc_metadata/data/documents/sfs-umn.yaml index a1cbd0b1..ecdf1d40 100644 --- a/otc_metadata/data/documents/sfs-umn.yaml +++ b/otc_metadata/data/documents/sfs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/sfs html_location: docs/sfs/umn link: /scalable-file-service/umn/ -pdf_name: sfs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: sfs title: User Guide diff --git a/otc_metadata/data/documents/smg-umn.yaml b/otc_metadata/data/documents/smg-umn.yaml index e1c4e4e5..554eaae6 100644 --- a/otc_metadata/data/documents/smg-umn.yaml +++ b/otc_metadata/data/documents/smg-umn.yaml @@ -1,7 +1,8 @@ --- hc_location: usermanual/smg link: /secure-mail-gateway/umn/ -pdf_name: smg-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: smg title: User Guide diff --git a/otc_metadata/data/documents/smn-api-ref.yaml b/otc_metadata/data/documents/smn-api-ref.yaml index a2082dcf..d985f084 100644 --- a/otc_metadata/data/documents/smn-api-ref.yaml +++ b/otc_metadata/data/documents/smn-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/smn html_location: docs/smn/api-ref link: /simple-message-notification/api-ref/ -pdf_name: smn-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: smn title: API Reference diff --git a/otc_metadata/data/documents/smn-umn.yaml b/otc_metadata/data/documents/smn-umn.yaml index bf3922c9..8021dfb3 100644 --- a/otc_metadata/data/documents/smn-umn.yaml +++ b/otc_metadata/data/documents/smn-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/smn html_location: docs/smn/umn link: /simple-message-notification/umn/ -pdf_name: smn-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: smn title: User Guide diff --git a/otc_metadata/data/documents/swr-api-ref.yaml b/otc_metadata/data/documents/swr-api-ref.yaml index c0bf88ce..d708318e 100644 --- a/otc_metadata/data/documents/swr-api-ref.yaml +++ b/otc_metadata/data/documents/swr-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/swr html_location: docs/swr/api-ref link: /software-repository-container/api-ref/ -pdf_name: swr-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: swr title: API Reference diff --git a/otc_metadata/data/documents/swr-best-practice.yaml b/otc_metadata/data/documents/swr-best-practice.yaml index 3fe6618b..7b269110 100644 --- a/otc_metadata/data/documents/swr-best-practice.yaml +++ b/otc_metadata/data/documents/swr-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/swr environment: internal html_location: docs/swr/best-practice link: /software-repository-container/best-practice/ -pdf_name: swr-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: swr title: Best Practice diff --git a/otc_metadata/data/documents/swr-umn.yaml b/otc_metadata/data/documents/swr-umn.yaml index e5b32cf0..f6d5e70a 100644 --- a/otc_metadata/data/documents/swr-umn.yaml +++ b/otc_metadata/data/documents/swr-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/swr html_location: docs/swr/umn link: /software-repository-container/umn/ -pdf_name: swr-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: swr title: User Guide diff --git a/otc_metadata/data/documents/taurusdb-api-ref.yaml b/otc_metadata/data/documents/taurusdb-api-ref.yaml new file mode 100644 index 00000000..09a1bd6b --- /dev/null +++ b/otc_metadata/data/documents/taurusdb-api-ref.yaml @@ -0,0 +1,11 @@ +--- +hc_location: api/taurusdb +html_location: docs/taurusdb/api-ref +environment: internal +link: /taurusdb/api-ref/ +pdf_enabled: true +pdf_environment: internal +rst_location: api-ref/source +service_type: taurusdb +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/taurusdb-umn.yaml b/otc_metadata/data/documents/taurusdb-umn.yaml new file mode 100644 index 00000000..af4bfccf --- /dev/null +++ b/otc_metadata/data/documents/taurusdb-umn.yaml @@ -0,0 +1,11 @@ +--- +hc_location: usermanual/taurusdb +html_location: docs/taurusdb/umn +environment: internal +link: /taurusdb/umn/ +pdf_enabled: true +pdf_environment: internal +rst_location: umn/source +service_type: taurusdb +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/tms-api-ref.yaml b/otc_metadata/data/documents/tms-api-ref.yaml index f933c612..f235847f 100644 --- a/otc_metadata/data/documents/tms-api-ref.yaml +++ b/otc_metadata/data/documents/tms-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/tms html_location: docs/tms/api-ref link: /tag-management-service/api-ref/ -pdf_name: tms-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: tms title: API Reference diff --git a/otc_metadata/data/documents/tms-best-practice.yaml b/otc_metadata/data/documents/tms-best-practice.yaml index 44910eca..5624091a 100644 --- a/otc_metadata/data/documents/tms-best-practice.yaml +++ b/otc_metadata/data/documents/tms-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/tms environment: internal html_location: docs/tms/best-practice link: /tag-management-service/best-practice/ -pdf_name: tms-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: tms title: Best Practice diff --git a/otc_metadata/data/documents/tms-umn.yaml b/otc_metadata/data/documents/tms-umn.yaml index b7b4ed0f..7e50ac7a 100644 --- a/otc_metadata/data/documents/tms-umn.yaml +++ b/otc_metadata/data/documents/tms-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/tms html_location: docs/tms/umn link: /tag-management-service/umn/ -pdf_name: tms-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: tms title: User Guide diff --git a/otc_metadata/data/documents/vbs-api-ref.yaml b/otc_metadata/data/documents/vbs-api-ref.yaml index 994bf928..ff67d382 100644 --- a/otc_metadata/data/documents/vbs-api-ref.yaml +++ b/otc_metadata/data/documents/vbs-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/vbs html_location: docs/vbs/api-ref link: /volume-backup-service/api-ref/ -pdf_name: vbs-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: vbs title: API Reference diff --git a/otc_metadata/data/documents/vbs-umn.yaml b/otc_metadata/data/documents/vbs-umn.yaml index ae821144..9815151f 100644 --- a/otc_metadata/data/documents/vbs-umn.yaml +++ b/otc_metadata/data/documents/vbs-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/vbs html_location: docs/vbs/umn link: /volume-backup-service/umn/ -pdf_name: vbs-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: vbs title: User Guide diff --git a/otc_metadata/data/documents/vpc-api-ref.yaml b/otc_metadata/data/documents/vpc-api-ref.yaml index c934606b..f1ed740a 100644 --- a/otc_metadata/data/documents/vpc-api-ref.yaml +++ b/otc_metadata/data/documents/vpc-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/vpc html_location: docs/vpc/api-ref link: /virtual-private-cloud/api-ref/ -pdf_name: vpc-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: vpc title: API Reference diff --git a/otc_metadata/data/documents/vpc-best-practice.yaml b/otc_metadata/data/documents/vpc-best-practice.yaml index 36e61d85..d56714ab 100644 --- a/otc_metadata/data/documents/vpc-best-practice.yaml +++ b/otc_metadata/data/documents/vpc-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/vpc environment: internal html_location: docs/vpc/best-practice link: /virtual-private-cloud/best-practice/ -pdf_name: vpc-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: vpc title: Best Practice diff --git a/otc_metadata/data/documents/vpc-umn.yaml b/otc_metadata/data/documents/vpc-umn.yaml index 1968dafe..e163908f 100644 --- a/otc_metadata/data/documents/vpc-umn.yaml +++ b/otc_metadata/data/documents/vpc-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/vpc html_location: docs/vpc/umn link: /virtual-private-cloud/umn/ -pdf_name: vpc-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: vpc title: User Guide diff --git a/otc_metadata/data/documents/vpcep-api-ref.yaml b/otc_metadata/data/documents/vpcep-api-ref.yaml index 2cc5810e..c976cceb 100644 --- a/otc_metadata/data/documents/vpcep-api-ref.yaml +++ b/otc_metadata/data/documents/vpcep-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/vpcep html_location: docs/vpcep/api-ref link: /vpc-endpoint/api-ref/ -pdf_name: vpcep-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: vpcep title: API Reference diff --git a/otc_metadata/data/documents/vpcep-umn.yaml b/otc_metadata/data/documents/vpcep-umn.yaml index d3690d74..74dee955 100644 --- a/otc_metadata/data/documents/vpcep-umn.yaml +++ b/otc_metadata/data/documents/vpcep-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/vpcep html_location: docs/vpcep/umn link: /vpc-endpoint/umn/ -pdf_name: vpcep-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: vpcep title: User Guide diff --git a/otc_metadata/data/documents/vpn-api-ref.yaml b/otc_metadata/data/documents/vpn-api-ref.yaml index f2b13759..99c5d500 100644 --- a/otc_metadata/data/documents/vpn-api-ref.yaml +++ b/otc_metadata/data/documents/vpn-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/vpn html_location: docs/vpn/api-ref link: /virtual-private-network/api-ref/ -pdf_name: vpn-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: vpn title: API Reference diff --git a/otc_metadata/data/documents/vpn-umn.yaml b/otc_metadata/data/documents/vpn-umn.yaml index de8ddef6..b19f5bd0 100644 --- a/otc_metadata/data/documents/vpn-umn.yaml +++ b/otc_metadata/data/documents/vpn-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/vpn html_location: docs/vpn/umn link: /virtual-private-network/umn/ -pdf_name: vpn-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: vpn title: User Guide diff --git a/otc_metadata/data/documents/waf-api-ref.yaml b/otc_metadata/data/documents/waf-api-ref.yaml index 9b0758ef..15b885db 100644 --- a/otc_metadata/data/documents/waf-api-ref.yaml +++ b/otc_metadata/data/documents/waf-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/waf html_location: docs/waf/api-ref link: /web-application-firewall/api-ref/ -pdf_name: waf-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: waf title: API Reference diff --git a/otc_metadata/data/documents/waf-umn.yaml b/otc_metadata/data/documents/waf-umn.yaml index c983f96a..97ff787c 100644 --- a/otc_metadata/data/documents/waf-umn.yaml +++ b/otc_metadata/data/documents/waf-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/waf html_location: docs/waf/umn link: /web-application-firewall/umn/ -pdf_name: waf-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: waf title: User Guide diff --git a/otc_metadata/data/documents/wafd-api-ref.yaml b/otc_metadata/data/documents/wafd-api-ref.yaml index 0655885e..96f18be8 100644 --- a/otc_metadata/data/documents/wafd-api-ref.yaml +++ b/otc_metadata/data/documents/wafd-api-ref.yaml @@ -2,7 +2,8 @@ hc_location: api/dwaf html_location: docs/wafd/api-ref link: /web-application-firewall-dedicated/api-ref/ -pdf_name: wafd-api-ref +pdf_enabled: true +pdf_environment: public rst_location: api-ref/source service_type: wafd title: API Reference diff --git a/otc_metadata/data/documents/wafd-best-practice.yaml b/otc_metadata/data/documents/wafd-best-practice.yaml index 6ea22c81..bff9ecbd 100644 --- a/otc_metadata/data/documents/wafd-best-practice.yaml +++ b/otc_metadata/data/documents/wafd-best-practice.yaml @@ -3,7 +3,8 @@ hc_location: bestpractice/waf environment: internal html_location: docs/wafd/best-practice link: /web-application-firewall-dedicated/best-practice/ -pdf_name: wafd-best-practice +pdf_enabled: true +pdf_environment: public rst_location: doc/best-practice/source service_type: wafd title: Best Practice diff --git a/otc_metadata/data/documents/wafd-umn.yaml b/otc_metadata/data/documents/wafd-umn.yaml index c358e379..0fde02de 100644 --- a/otc_metadata/data/documents/wafd-umn.yaml +++ b/otc_metadata/data/documents/wafd-umn.yaml @@ -2,7 +2,8 @@ hc_location: usermanual/dwaf html_location: docs/wafd/umn link: /web-application-firewall-dedicated/umn/ -pdf_name: wafd-umn +pdf_enabled: true +pdf_environment: public rst_location: umn/source service_type: wafd title: User Guide diff --git a/otc_metadata/data/service_categories/big_data.yaml b/otc_metadata/data/service_categories/big_data.yaml index 5951c5f7..7fad6c6e 100644 --- a/otc_metadata/data/service_categories/big_data.yaml +++ b/otc_metadata/data/service_categories/big_data.yaml @@ -1,3 +1,3 @@ --- name: big_data -title: Big Data and Data Analysis +title: Data Analysis diff --git a/otc_metadata/data/service_categories/network.yaml b/otc_metadata/data/service_categories/network.yaml index bd0a98be..e1524b34 100644 --- a/otc_metadata/data/service_categories/network.yaml +++ b/otc_metadata/data/service_categories/network.yaml @@ -1,3 +1,3 @@ --- name: network -title: Networking +title: Network diff --git a/otc_metadata/data/services/ac.yaml b/otc_metadata/data/services/ac.yaml deleted file mode 100644 index 6cd16624..00000000 --- a/otc_metadata/data/services/ac.yaml +++ /dev/null @@ -1,16 +0,0 @@ ---- -environment: hidden -repositories: -- environment: internal - repo: docs/architecture-center - type: gitea -- environment: public - repo: opentelekomcloud-docs/architecture-center - type: github -service_category: other -service_title: Architecture Center -service_type: ac -service_uri: architecture-center -teams: -- name: docs-architecture-center-rw - permission: write diff --git a/otc_metadata/data/services/aom.yaml b/otc_metadata/data/services/aom.yaml index 5a8569f3..0f3036e9 100644 --- a/otc_metadata/data/services/aom.yaml +++ b/otc_metadata/data/services/aom.yaml @@ -12,5 +12,5 @@ service_title: Application Operations Management service_type: aom service_uri: application-operations-management teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/aom2.yaml b/otc_metadata/data/services/aom2.yaml index 41fd15ed..bc5ae992 100644 --- a/otc_metadata/data/services/aom2.yaml +++ b/otc_metadata/data/services/aom2.yaml @@ -12,5 +12,5 @@ service_title: Application Operations Management 2.0 service_type: aom2 service_uri: application-operations-management-2 teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/apig.yaml b/otc_metadata/data/services/apig.yaml index 3faf70c0..aaf82d77 100644 --- a/otc_metadata/data/services/apig.yaml +++ b/otc_metadata/data/services/apig.yaml @@ -12,5 +12,5 @@ service_title: API Gateway (APIG) service_type: apig service_uri: api-gateway teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/apiu.yaml b/otc_metadata/data/services/apiu.yaml index 9019c794..584c60e0 100644 --- a/otc_metadata/data/services/apiu.yaml +++ b/otc_metadata/data/services/apiu.yaml @@ -1,5 +1,5 @@ --- -environment: internal +environment: hidden repositories: - environment: internal repo: docs/api-usage diff --git a/otc_metadata/data/services/apm.yaml b/otc_metadata/data/services/apm.yaml index 7cac58dc..bfbffce6 100644 --- a/otc_metadata/data/services/apm.yaml +++ b/otc_metadata/data/services/apm.yaml @@ -7,10 +7,10 @@ repositories: - environment: public repo: opentelekomcloud-docs/application-performance-management type: github -service_category: md +service_category: application service_title: Application Performance Management service_type: apm service_uri: application-performance-management teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/asm.yaml b/otc_metadata/data/services/asm.yaml index 4ee49e9e..58829105 100644 --- a/otc_metadata/data/services/asm.yaml +++ b/otc_metadata/data/services/asm.yaml @@ -1,5 +1,5 @@ --- -environment: internal +environment: public repositories: - environment: internal repo: docs/application-service-mesh diff --git a/otc_metadata/data/services/blueprints.yaml b/otc_metadata/data/services/blueprints.yaml deleted file mode 100644 index 50c57585..00000000 --- a/otc_metadata/data/services/blueprints.yaml +++ /dev/null @@ -1,16 +0,0 @@ ---- -environment: hidden -repositories: -- environment: internal - repo: docs/blueprints - type: gitea -- environment: public - repo: opentelekomcloud-docs/blueprints - type: github -service_category: other -service_title: Blueprints -service_type: blueprints -service_uri: blueprints -teams: -- name: eco - permission: write diff --git a/otc_metadata/data/services/cci.yaml b/otc_metadata/data/services/cci.yaml index 65c36dc8..82fa2ee4 100644 --- a/otc_metadata/data/services/cci.yaml +++ b/otc_metadata/data/services/cci.yaml @@ -1,5 +1,5 @@ --- -environment: internal +environment: public repositories: - environment: internal repo: docs/cloud-container-instance diff --git a/otc_metadata/data/services/ccn.yaml b/otc_metadata/data/services/ccn.yaml new file mode 100644 index 00000000..4dfc051b --- /dev/null +++ b/otc_metadata/data/services/ccn.yaml @@ -0,0 +1,16 @@ +--- +environment: internal +repositories: +- environment: internal + repo: docs/cloud-connect + type: gitea +- environment: public + repo: opentelekomcloud-docs/cloud-connect + type: github +service_category: network +service_title: Cloud Connect +service_type: ccn +service_uri: cloud-connect +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/ces.yaml b/otc_metadata/data/services/ces.yaml index 9bddea02..320b0f95 100644 --- a/otc_metadata/data/services/ces.yaml +++ b/otc_metadata/data/services/ces.yaml @@ -12,5 +12,5 @@ service_title: Cloud Eye service_type: ces service_uri: cloud-eye teams: -- name: docs-orchestration-rw +- name: docs-cms-rw permission: write diff --git a/otc_metadata/data/services/cfw.yaml b/otc_metadata/data/services/cfw.yaml index 9e9af53f..ec800f0b 100644 --- a/otc_metadata/data/services/cfw.yaml +++ b/otc_metadata/data/services/cfw.yaml @@ -1,5 +1,5 @@ --- -environment: internal +environment: public repositories: - environment: internal repo: docs/cloud-firewall diff --git a/otc_metadata/data/services/config.yaml b/otc_metadata/data/services/config.yaml index 38ce85bf..699a9567 100644 --- a/otc_metadata/data/services/config.yaml +++ b/otc_metadata/data/services/config.yaml @@ -1,5 +1,5 @@ --- -environment: internal +environment: public repositories: - environment: internal repo: docs/config @@ -12,5 +12,5 @@ service_title: Config service_type: config service_uri: config teams: -- name: docs-orchestration-rw +- name: docs-cms-rw permission: write diff --git a/otc_metadata/data/services/cse.yaml b/otc_metadata/data/services/cse.yaml index dbe0016c..9d11c2ca 100644 --- a/otc_metadata/data/services/cse.yaml +++ b/otc_metadata/data/services/cse.yaml @@ -12,5 +12,5 @@ service_title: Cloud Service Engine service_type: cse service_uri: cloud-service-engine teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/cts.yaml b/otc_metadata/data/services/cts.yaml index 3d3e9f6b..41343248 100644 --- a/otc_metadata/data/services/cts.yaml +++ b/otc_metadata/data/services/cts.yaml @@ -12,5 +12,5 @@ service_title: Cloud Trace Service service_type: cts service_uri: cloud-trace-service teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/das.yaml b/otc_metadata/data/services/das.yaml new file mode 100644 index 00000000..f7f98b31 --- /dev/null +++ b/otc_metadata/data/services/das.yaml @@ -0,0 +1,16 @@ +--- +environment: internal +repositories: +- environment: internal + repo: docs/data-admin-service + type: gitea +- environment: public + repo: opentelekomcloud-docs/data-admin-service + type: github +service_category: database +service_title: Data Admin Service +service_type: das +service_uri: data-admin-service +teams: +- name: docs-database-rw + permission: write diff --git a/otc_metadata/data/services/dcs.yaml b/otc_metadata/data/services/dcs.yaml index 52da2696..b353e855 100644 --- a/otc_metadata/data/services/dcs.yaml +++ b/otc_metadata/data/services/dcs.yaml @@ -12,5 +12,5 @@ service_title: Distributed Cache Service service_type: dcs service_uri: distributed-cache-service teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/dms.yaml b/otc_metadata/data/services/dms.yaml index a6cbd244..70a7c378 100644 --- a/otc_metadata/data/services/dms.yaml +++ b/otc_metadata/data/services/dms.yaml @@ -12,5 +12,5 @@ service_title: Distributed Message Service service_type: dms service_uri: distributed-message-service teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/ed.yaml b/otc_metadata/data/services/ed.yaml index 068fd9dd..f9c2275a 100644 --- a/otc_metadata/data/services/ed.yaml +++ b/otc_metadata/data/services/ed.yaml @@ -1,9 +1,6 @@ --- environment: public repositories: -- environment: internal - repo: docs/enterprise-dashboard - type: gitea - environment: public repo: opentelekomcloud-docs/enterprise-dashboard type: github diff --git a/otc_metadata/data/services/eps.yaml b/otc_metadata/data/services/eps.yaml new file mode 100644 index 00000000..ac630b1a --- /dev/null +++ b/otc_metadata/data/services/eps.yaml @@ -0,0 +1,17 @@ +--- +environment: internal +repositories: +- environment: internal + repo: docs/enterprise-project-service + type: gitea +- environment: public + repo: opentelekomcloud-docs/enterprise-project-service + type: github +service_category: security-services +service_title: Enterprise Project Service +service_type: eps +service_uri: enterprise-project-service +teams: +- name: docs-security-services-rw + permission: write + diff --git a/otc_metadata/data/services/fg.yaml b/otc_metadata/data/services/fg.yaml index 14af8aeb..a744a8f9 100644 --- a/otc_metadata/data/services/fg.yaml +++ b/otc_metadata/data/services/fg.yaml @@ -12,5 +12,5 @@ service_title: FunctionGraph service_type: fg service_uri: function-graph teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/gaussdb_nosql.yaml b/otc_metadata/data/services/gaussdb_nosql.yaml deleted file mode 100644 index 0e335c4f..00000000 --- a/otc_metadata/data/services/gaussdb_nosql.yaml +++ /dev/null @@ -1,16 +0,0 @@ ---- -environment: public -repositories: -- environment: internal - repo: docs/gaussdb-nosql - type: gitea -- environment: public - repo: opentelekomcloud-docs/gaussdb-nosql - type: github -service_category: database -service_title: GaussDB NoSQL -service_type: gaussdb_nosql -service_uri: gaussdb-nosql -teams: -- name: docs-database-rw - permission: write diff --git a/otc_metadata/data/services/lts.yaml b/otc_metadata/data/services/lts.yaml index 34d13e41..57a2d466 100644 --- a/otc_metadata/data/services/lts.yaml +++ b/otc_metadata/data/services/lts.yaml @@ -12,5 +12,5 @@ service_title: Log Tank Service service_type: lts service_uri: log-tank-service teams: -- name: docs-orchestration-rw +- name: docs-paas-rw permission: write diff --git a/otc_metadata/data/services/obs_3rd_party.yaml b/otc_metadata/data/services/obs_3rd_party.yaml new file mode 100644 index 00000000..d7e9e890 --- /dev/null +++ b/otc_metadata/data/services/obs_3rd_party.yaml @@ -0,0 +1,16 @@ +--- +environment: internal +repositories: +- environment: internal + repo: docs/object-storage-service-3rd-party + type: gitea +- environment: public + repo: opentelekomcloud-docs/object-storage-service-3rd-party + type: github +service_category: storage +service_title: Object Storage Service 3rd Party +service_type: obs_3rd_party +service_uri: object-storage-service-3rd-party +teams: +- name: docs-storage-rw + permission: write diff --git a/otc_metadata/data/services/pc.yaml b/otc_metadata/data/services/pc.yaml index b2d3df0c..9bf37c05 100644 --- a/otc_metadata/data/services/pc.yaml +++ b/otc_metadata/data/services/pc.yaml @@ -1,5 +1,5 @@ --- -environment: hidden +environment: public repositories: - environment: internal repo: docs/price-calculator diff --git a/otc_metadata/data/services/rfs.yaml b/otc_metadata/data/services/rfs.yaml index aa51d494..04ab1fa8 100644 --- a/otc_metadata/data/services/rfs.yaml +++ b/otc_metadata/data/services/rfs.yaml @@ -1,5 +1,5 @@ --- -environment: internal +environment: public repositories: - environment: internal repo: docs/resource-formation-service @@ -7,10 +7,10 @@ repositories: - environment: public repo: opentelekomcloud-docs/resource-formation-service type: github -service_category: application +service_category: md service_title: Resource Formation Service service_type: rfs service_uri: resource-formation-service teams: -- name: docs-orchestration-rw +- name: docs-cms-rw permission: write diff --git a/otc_metadata/data/services/rms.yaml b/otc_metadata/data/services/rms.yaml deleted file mode 100644 index 818806a2..00000000 --- a/otc_metadata/data/services/rms.yaml +++ /dev/null @@ -1,16 +0,0 @@ ---- -environment: public -repositories: -- environment: internal - repo: docs/resource-management-service - type: gitea -- environment: public - repo: opentelekomcloud-docs/resource-management-service - type: github -service_category: md -service_title: Resource Management Service -service_type: rms -service_uri: resource-management-service -teams: -- name: docs-orchestration-rw - permission: write diff --git a/otc_metadata/data/services/smn.yaml b/otc_metadata/data/services/smn.yaml index b661a61a..7fb036f6 100644 --- a/otc_metadata/data/services/smn.yaml +++ b/otc_metadata/data/services/smn.yaml @@ -12,5 +12,5 @@ service_title: Simple Message Notification service_type: smn service_uri: simple-message-notification teams: -- name: docs-orchestration-rw +- name: docs-cms-rw permission: write diff --git a/otc_metadata/data/services/taurusdb.yaml b/otc_metadata/data/services/taurusdb.yaml new file mode 100644 index 00000000..489f0638 --- /dev/null +++ b/otc_metadata/data/services/taurusdb.yaml @@ -0,0 +1,16 @@ +--- +environment: internal +repositories: +- environment: internal + repo: docs/taurusdb + type: gitea +- environment: public + repo: opentelekomcloud-docs/taurusdb + type: github +service_category: database +service_title: TaurusDB +service_type: taurusdb +service_uri: taurusdb +teams: +- name: docs-database-rw + permission: write diff --git a/otc_metadata/data/services/tms.yaml b/otc_metadata/data/services/tms.yaml index b0c7195b..84bda50e 100644 --- a/otc_metadata/data/services/tms.yaml +++ b/otc_metadata/data/services/tms.yaml @@ -12,5 +12,5 @@ service_title: Tag Management Service service_type: tms service_uri: tag-management-service teams: -- name: docs-orchestration-rw +- name: docs-cms-rw permission: write diff --git a/otc_metadata/templates/conf.py.j2 b/otc_metadata/templates/conf.py.j2 index 7db2f711..e98e7cd1 100644 --- a/otc_metadata/templates/conf.py.j2 +++ b/otc_metadata/templates/conf.py.j2 @@ -16,6 +16,8 @@ import os import sys +from git import Repo +from datetime import datetime extensions = [ 'otcdocstheme', @@ -117,17 +119,40 @@ html_title = "{{ title }}" # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +templates_path = ['_templates'] # Do not include sources into the rendered results html_copy_source = False # -- Options for PDF output -------------------------------------------------- latex_documents = [ -{%- if pdf_name is defined %} +{%- if doc_type %} ('index', - '{{ pdf_name }}.tex', + {%- if doc_type == 'dev' %} + '{{ service_type }}-dev-guide.tex', + {%- else %} + '{{ service_type }}-{{ doc_type }}.tex', + {% endif -%} u'{{ title }}', u'OpenTelekomCloud', 'manual'), {% endif -%} ] +# Get the Git commit values for last updated timestamp on each page +repo = Repo(search_parent_directories=True) +commit = repo.head.commit +current_commit_hash = commit.hexsha +current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M') + +latex_elements = { + 'papersize': 'a4paper', + 'pointsize': '12pt', + 'figure_align': 'H', + 'preamble': rf'''{% raw %} + \newcommand{{\githash}}{{{current_commit_hash}}} + \newcommand{{\gitcommittime}}{{{current_commit_time}}} + \newcommand{{\doctitle}}{{{otcdocs_doc_title}}} + \newcommand{{\servicetitle}}{{{otcdocs_service_title}}}{% endraw %} + ''', + 'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm' +} diff --git a/otc_metadata/templates/doc_requirements.txt.j2 b/otc_metadata/templates/doc_requirements.txt.j2 index 3f070fc4..61cdd1bf 100644 --- a/otc_metadata/templates/doc_requirements.txt.j2 +++ b/otc_metadata/templates/doc_requirements.txt.j2 @@ -12,4 +12,5 @@ reno>=3.1.0 # Apache-2.0 otc-sphinx-directives>=0.1.0 sphinx-minify>=0.0.1 # Apache-2.0 git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata -setuptools \ No newline at end of file +setuptools +gitpython diff --git a/otc_metadata/templates/tox.ini.j2 b/otc_metadata/templates/tox.ini.j2 index 8be94f0e..edfd5f11 100644 --- a/otc_metadata/templates/tox.ini.j2 +++ b/otc_metadata/templates/tox.ini.j2 @@ -44,7 +44,8 @@ commands = {[testenv:json-{{ doc.type }}]commands} {%- endfor %} -[testenv:docs-pdf] +{% if docs|length > 0 %} +[testenv:pdf-docs] deps = {[testenv:docs]deps} {[testenv:bindeps]deps} @@ -57,12 +58,18 @@ allowlist_externals = cp commands = mkdir -p doc/build/pdf + mkdir -p doc/build/html {[testenv:bindeps]commands} + mkdir -p {toxinidir}/_templates + wget -O {toxinidir}/_templates/longtable.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/longtable.tex.jinja + wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja + wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja {%- for doc in docs %} -{%- if doc.pdf_name %} +{%- if doc.pdf_enabled %} {[testenv:{{ doc.type }}-pdf-docs]commands} {%- endif %} {%- endfor %} +{% endif %} {% for doc in docs -%} {% set loc = doc.rst_location | replace('/source', '') %} @@ -103,7 +110,6 @@ commands = cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json {%- endif %} -{% if doc.pdf_name -%} # PDF version [testenv:{{ doc.type }}-pdf-docs] deps = {[testenv:docs]deps} @@ -115,13 +121,14 @@ allowlist_externals = cp commands = rm -rf {{ loc }}/build/pdf + cp -r {toxinidir}/_templates {{ loc }}/source/_templates/ sphinx-build -W --keep-going -b latex {{ loc }}/source {{ loc }}/build/pdf/ - bash -c "for f in {{ loc }}/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true" + bash -c "for f in {{ loc }}/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true" bash -c "for f in {{ loc }}/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done" - make -C {{ loc }}/build/pdf + make -C {{ loc }}/build/pdf LATEXMKOPTS="-interaction=nonstopmode" mkdir -p doc/build/pdf - cp {{ loc }}/build/pdf/{{ doc.pdf_name }}.pdf doc/build/pdf/ -{% endif %} + cp {{ loc }}/build/pdf/{{ service_type }}-{{ doc.type }}.pdf doc/build/pdf/ + cp {{ loc }}/build/pdf/{{ service_type }}-{{ doc.type }}.pdf doc/build/html/ {% endfor %} [testenv:bindeps] diff --git a/otc_metadata/templates/zuul.yaml.j2 b/otc_metadata/templates/zuul.yaml.j2 index 107ef29c..f0f61120 100644 --- a/otc_metadata/templates/zuul.yaml.j2 +++ b/otc_metadata/templates/zuul.yaml.j2 @@ -4,6 +4,13 @@ default-branch: main templates: - helpcenter-base-jobs + vars: + sphinx_pdf_files: + {%- for doc in docs %} + {%- if doc.pdf_enabled %} + - {{ service_type }}-{{ doc.type }}.pdf + {%- endif %} + {%- endfor %} check: jobs: - noop diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index ea4562e6..2bd5d8f2 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -44,6 +44,7 @@ def process_repositories(args, service): url_to = None target_repo = None git_fqdn = None + error_list = [] env = Environment( loader=PackageLoader("otc_metadata"), autoescape=select_autoescape() @@ -75,7 +76,11 @@ def process_repositories(args, service): repo_url = f"git@github.com:/{repo['repo']}" else: logging.error(f"Repository type {repo['type']} is not supported") - exit(1) + error_list.append({ + "error": f"Repository type {repo['type']} is not supported", + "repo": repo['repo'] + }) + continue if repo_dir.exists(): logging.debug(f"Repository {repo} already checked out") @@ -87,13 +92,22 @@ def process_repositories(args, service): except exc.InvalidGitRepositoryError: logging.error("Existing repository checkout is bad") repo_dir.rmdir() + except Exception as e: + error_list.append({ + "error": e, + "repo": repo['repo'] + }) if not repo_dir.exists(): try: git_repo = Repo.clone_from(repo_url, repo_dir, branch="main") except Exception: logging.error(f"Error cloning repository {repo_url}") - return + error_list.append({ + "error": f"Error cloning repository {repo_url}", + "repo": repo['repo'] + }) + continue if repo["environment"] == args.target_environment: url_to = repo_url @@ -116,11 +130,19 @@ def process_repositories(args, service): repo_to.delete_head(f"refs/heads/{args.branch_name}", force=True) except exc.GitCommandError as e: print(e) + error_list.append({ + "error": e, + "repo": target_repo['repo'] + }) pass try: new_branch = repo_to.create_head(branch_name, "main") except Exception as e: logging.warning(f"Skipping service {service} due to {e}") + error_list.append({ + "error": e, + "repo": target_repo['repo'] + }) return new_branch.checkout() @@ -145,7 +167,23 @@ def process_repositories(args, service): context["git_fqdn"] = git_fqdn if target_repo.get("type") != "github": context["git_type"] = target_repo["type"] - if args.target_environment == "internal": + if (args.target_environment == "public" + and target_repo["repo"].split("/")[0] == "opentelekomcloud-docs-swiss"): + context["html_options"] = dict( + logo_url="https://docs.sc.otc.t-systems.com", + ) + elif (args.target_environment == "public"): + context["html_options"] = dict( + logo_url="https://docs.otc.t-systems.com", + ) + elif (args.target_environment == "internal" + and target_repo["repo"].split("/")[0] == "docs-swiss"): + context["html_options"] = dict( + disable_search=True, + site_name="Internal Documentation Portal", + logo_url="https://docs-swiss-int.otc-service.com", + ) + elif args.target_environment == "internal": context["html_options"] = dict( disable_search=True, site_name="Internal Documentation Portal", @@ -195,7 +233,23 @@ def process_repositories(args, service): context["git_fqdn"] = git_fqdn if target_repo.get("type") != "github": context["git_type"] = target_repo["type"] - if args.target_environment == "internal": + if (args.target_environment == "public" + and target_repo["repo"].split("/")[0] == "opentelekomcloud-docs-swiss"): + context["html_options"] = dict( + logo_url="https://docs.sc.otc.t-systems.com", + ) + elif (args.target_environment == "public"): + context["html_options"] = dict( + logo_url="https://docs.otc.t-systems.com", + ) + elif (args.target_environment == "internal" + and target_repo["repo"].split("/")[0] == "docs-swiss"): + context["html_options"] = dict( + disable_search=True, + site_name="Internal Documentation Portal", + logo_url="https://docs-swiss-int.otc-service.com", + ) + elif args.target_environment == "internal": context["html_options"] = dict( disable_search=True, site_name="Internal Documentation Portal", @@ -240,6 +294,7 @@ def process_repositories(args, service): context["docs"].append(doc) context["target_environment"] = args.target_environment + context["service_type"] = service['service_type'] tox_ini_content = tox_ini_template.render(**context) tox_ini_path = pathlib.Path(copy_to, "tox.ini") @@ -263,6 +318,12 @@ def process_repositories(args, service): if args.update_zuul: """Update zuul.yaml""" + context = dict(docs=[]) + for doc in service_docs: + if doc["type"] == "dev": + doc["type"] = "dev-guide" + context["docs"].append(doc) + context["service_type"] = service['service_type'] zuul_yaml_content = zuul_yaml_template.render(**context) zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml") @@ -283,7 +344,13 @@ def process_repositories(args, service): push_args = ["--set-upstream", "origin", branch_name] if args.force_push: push_args.append("--force") - repo_to.git.push(*push_args) + try: + repo_to.git.push(*push_args) + except Exception as e: + error_list.append({ + "error": e, + "repo": repo['repo'] + }) if "github" in url_to: subprocess.run( args=["gh", "pr", "create", "-f"], cwd=copy_to, check=False @@ -297,6 +364,9 @@ def process_repositories(args, service): head=branch_name, ), ) + if len(error_list) != 0: + logging.error("The following errors have happened:") + logging.error(error_list) def open_pr(args, repository, pr_data): diff --git a/tox.ini b/tox.ini index 3b5961d1..74aa87e1 100644 --- a/tox.ini +++ b/tox.ini @@ -20,6 +20,6 @@ commands = {posargs} [flake8] # E123, E125 skipped as they are invalid PEP-8. show-source = True -ignore = E123,E125,W503 +ignore = E123,E125,W503,E501 builtins = _ exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build