diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 8eea61a4..dbb7606d 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -1,330 +1,378 @@ documents: - - html_location: docs/antiddos/api-ref + - hc_location: api/antiddos + html_location: docs/antiddos/api-ref link: /api-ref/anti-ddos/ pdf_name: antiddos-api-ref rst_location: api-ref/source service_type: antiddos title: API Reference type: api-ref - - html_location: docs/antiddos/umn + - hc_location: usermanual/antiddos + html_location: docs/antiddos/umn link: /umn/anti-ddos/ pdf_name: antiddos-umn rst_location: umn/source service_type: antiddos title: User Guide type: umn - - html_location: docs/aom/api-ref + - hc_location: api/aom + html_location: docs/aom/api-ref link: /api-ref/application-operations-management/ pdf_name: aom-api-ref rst_location: api-ref/source service_type: aom title: API Reference type: api-ref - - html_location: docs/aom/umn + - hc_location: usermanual/aom + html_location: docs/aom/umn link: /umn/application-operations-management/ pdf_name: aom-umn rst_location: umn/source service_type: aom title: User Guide type: umn - - html_location: docs/as/api-ref + - hc_location: api/as + html_location: docs/as/api-ref link: /api-ref/auto-scaling/ pdf_name: as-api-ref rst_location: api-ref/source service_type: as title: API Reference type: api-ref - - html_location: docs/as/dev + - hc_location: devg/as + html_location: docs/as/dev link: /dev/auto-scaling/ pdf_name: as-dev-guide rst_location: dev_guide/source service_type: as title: Developer Guide type: dev - - html_location: docs/as/umn + - hc_location: usermanual/as + html_location: docs/as/umn link: /umn/auto-scaling/ pdf_name: as-umn rst_location: umn/source service_type: as title: User Guide type: umn - - html_location: docs/bms/api-ref + - hc_location: api/bms + html_location: docs/bms/api-ref link: /api-ref/bare-metal-server/ pdf_name: bms-api-ref rst_location: api-ref/source service_type: bms title: API Reference type: api-ref - - html_location: docs/bms/dev + - hc_location: devg/bms + html_location: docs/bms/dev link: /dev/bare-metal-server/ pdf_name: bms-dev-guide rst_location: dev_guide/source service_type: bms title: Developer Guide type: dev - - html_location: docs/bms/image-creation-guide + - hc_location: bpicg/bms + html_location: docs/bms/image-creation-guide pdf_name: bms-image-creation-guide rst_location: docs/bms/image-creation-guide service_type: bms title: Private Image Creation Guide - - html_location: docs/bms/umn + - hc_location: usermanual/bms + html_location: docs/bms/umn link: /umn/bare-metal-server/ pdf_name: bms-umn rst_location: umn/source service_type: bms title: User Guide type: umn - - html_location: docs/cbr/api-ref + - hc_location: api/cbr + html_location: docs/cbr/api-ref link: /api-ref/cloud-backup-recovery/ pdf_name: cbr-api-ref rst_location: api-ref/source service_type: cbr title: API Reference type: api-ref - - html_location: docs/cbr/umn + - hc_location: usermanual/cbr + html_location: docs/cbr/umn link: /umn/cloud-backup-recovery/ pdf_name: cbr-umn rst_location: umn/source service_type: cbr title: User Guide type: umn - - html_location: docs/cce/api-ref + - hc_location: api/cce + html_location: docs/cce/api-ref link: /api-ref/cloud-container-engine/ pdf_name: cce-api-ref rst_location: api-ref/source service_type: cce title: API Reference type: api-ref - - html_location: docs/cce/umn + - hc_location: usermanual/cce + html_location: docs/cce/umn link: /umn/cloud-container-engine/ pdf_name: cce-umn rst_location: umn/source service_type: cce title: User Guide type: umn - - html_location: docs/cdn/umn + - hc_location: usermanual/cdn + html_location: docs/cdn/umn link: /umn/content-delivery-network/ pdf_name: cdn-umn rst_location: umn/source service_type: cdn title: User Guide type: umn - - html_location: docs/ces/api-ref + - hc_location: api/ces + html_location: docs/ces/api-ref link: /api-ref/cloud-eye/ pdf_name: ces-api-ref rst_location: api-ref/source service_type: ces title: API Reference type: api-ref - - html_location: docs/ces/umn + - hc_location: usermanual/ces + html_location: docs/ces/umn link: /umn/cloud-eye/ pdf_name: ces-umn rst_location: umn/source service_type: ces title: User Guide type: umn - - html_location: docs/csbs/api-ref + - hc_location: api/csbs + html_location: docs/csbs/api-ref link: /api-ref/cloud-server-backup-service/ pdf_name: csbs-api-ref rst_location: api-ref/source service_type: csbs title: API Reference type: api-ref - - html_location: docs/csbs/umn + - hc_location: usermanual/csbs + html_location: docs/csbs/umn link: /umn/cloud-server-backup-service/ pdf_name: csbs-umn rst_location: umn/source service_type: csbs title: User Guide type: umn - - html_location: docs/css/api-ref + - hc_location: api/css + html_location: docs/css/api-ref link: /api-ref/cloud-search-service/ pdf_name: css-api-ref rst_location: api-ref/source service_type: css title: API Reference type: api-ref - - html_location: docs/css/umn + - hc_location: usermanual/css + html_location: docs/css/umn link: /umn/cloud-search-service/ pdf_name: css-umn rst_location: umn/source service_type: css title: User Guide type: umn - - html_location: docs/cts/api-ref + - hc_location: api/cts + html_location: docs/cts/api-ref link: /api-ref/cloud-trace-service/ pdf_name: cts-api-ref rst_location: api-ref/source service_type: cts title: API Reference type: api-ref - - html_location: docs/cts/umn + - hc_location: usermanual/cts + html_location: docs/cts/umn link: /umn/cloud-trace-service/ pdf_name: cts-umn rst_location: umn/source service_type: cts title: User Guide type: umn - - html_location: docs/das/umn + - hc_location: usermanual/das + html_location: docs/das/umn link: /umn/data-admin-service/ pdf_name: das-umn rst_location: umn/source service_type: das title: User Guide type: umn - - html_location: docs/dc/api-ref + - hc_location: api/dc + html_location: docs/dc/api-ref link: /api-ref/direct-connect/ pdf_name: dc-api-ref rst_location: api-ref/source service_type: dc title: API Reference type: api-ref - - html_location: docs/dc/umn + - hc_location: usermanual/dc + html_location: docs/dc/umn link: /umn/direct-connect/ pdf_name: dc-umn rst_location: umn/source service_type: dc title: User Guide type: umn - - html_location: docs/dcs/api-ref + - hc_location: api/dcs + html_location: docs/dcs/api-ref link: /api-ref/distributed-cache-service/ pdf_name: dcs-api-ref rst_location: api-ref/source service_type: dcs title: API Reference type: api-ref - - html_location: docs/dcs/umn + - hc_location: usermanual/dcs + html_location: docs/dcs/umn link: /umn/distributed-cache-service/ pdf_name: dcs-umn rst_location: umn/source service_type: dcs title: User Guide type: umn - - html_location: docs/dds/api-ref + - hc_location: api/dds + html_location: docs/dds/api-ref link: /api-ref/document-database-service/ pdf_name: dds-api-ref rst_location: api-ref/source service_type: dds title: API Reference type: api-ref - - html_location: docs/dds/umn + - hc_location: usermanual/dds + html_location: docs/dds/umn link: /umn/document-database-service/ pdf_name: dds-umn rst_location: umn/source service_type: dds title: User Guide type: umn - - html_location: docs/deh/api-ref + - hc_location: api/deh + html_location: docs/deh/api-ref link: /api-ref/dedicated-host/ pdf_name: deh-api-ref rst_location: api-ref/source service_type: deh title: API Reference type: api-ref - - html_location: docs/deh/umn + - hc_location: usermanual/deh + html_location: docs/deh/umn link: /umn/dedicated-host/ pdf_name: deh-umn rst_location: umn/source service_type: deh title: User Guide type: umn - - html_location: docs/dis/api-ref + - hc_location: api/dis + html_location: docs/dis/api-ref link: /api-ref/data-ingestion-service/ pdf_name: dis-api-ref rst_location: api-ref/source service_type: dis title: API Reference type: api-ref - - html_location: docs/dis/umn + - hc_location: usermanual/dis + html_location: docs/dis/umn link: /umn/data-ingestion-service/ pdf_name: dis-umn rst_location: umn/source service_type: dis title: User Guide type: umn - - html_location: docs/dms/api-ref + - hc_location: api/dms + html_location: docs/dms/api-ref link: /api-ref/distributed-message-service/ pdf_name: dms-api-ref rst_location: api-ref/source service_type: dms title: API Reference type: api-ref - - html_location: docs/dms/dev + - hc_location: devg/dms + html_location: docs/dms/dev link: /dev/distributed-message-service/ pdf_name: dms-dev-guide rst_location: dev_guide/source service_type: dms title: Developer Guide type: dev - - html_location: docs/dms/umn + - hc_location: usermanual/dms + html_location: docs/dms/umn link: /umn/distributed-message-service/ pdf_name: dms-umn rst_location: umn/source service_type: dms title: User Guide type: umn - - html_location: docs/dns/api-ref + - hc_location: api/dns + html_location: docs/dns/api-ref link: /api-ref/domain-name-service/ pdf_name: dns-api-ref rst_location: api-ref/source service_type: dns title: API Reference type: api-ref - - html_location: docs/dns/umn + - hc_location: usermanual/dns + html_location: docs/dns/umn link: /umn/domain-name-service/ pdf_name: dns-umn rst_location: umn/source service_type: dns title: User Guide type: umn - - html_location: docs/drs/umn + - hc_location: usermanual/drs + html_location: docs/drs/umn link: /umn/data-replication-service/ pdf_name: drs-umn rst_location: umn/source service_type: drs title: User Guide type: umn - - html_location: docs/dws/api-ref + - hc_location: api/dws + html_location: docs/dws/api-ref link: /api-ref/data-warehouse-service/ pdf_name: dws-api-ref rst_location: api-ref/source service_type: dws title: API Reference type: api-ref - - html_location: docs/dws/dev + - hc_location: devg/dws + html_location: docs/dws/dev link: /dev/data-warehouse-service/ pdf_name: dws-dev-guide rst_location: dev_guide/source service_type: dws title: Developer Guide type: dev - - html_location: docs/dws/tool + - hc_location: tg/dws + html_location: docs/dws/tool pdf_name: dws-tool-guide rst_location: doc/tool/source service_type: dws title: Tool Guide - - html_location: docs/dws/umn + - hc_location: usermanual/dws + html_location: docs/dws/umn link: /umn/data-warehouse-service/ pdf_name: dws-umn rst_location: umn/source service_type: dws title: User Guide type: umn - - html_location: docs/ecs/api-ref + - hc_location: api/ecs + html_location: docs/ecs/api-ref link: /api-ref/elastic-cloud-server/ pdf_name: ecs-api-ref rst_location: api-ref/source service_type: ecs title: API Reference type: api-ref - - html_location: docs/ecs/dev + - hc_location: devg/ecs + html_location: docs/ecs/dev link: /dev/elastic-cloud-server/ pdf_name: ecs-dev-guide rst_location: dev_guide/source service_type: ecs title: Developer Guide type: dev - - html_location: docs/ecs/umn + - hc_location: usermanual/ecs + html_location: docs/ecs/umn link: /umn/elastic-cloud-server/ pdf_name: ecs-umn rst_location: umn/source @@ -336,98 +384,115 @@ documents: rst_location: umn/source service_type: edb title: User Guide - - html_location: docs/eip/api-ref + - hc_location: api/eip + html_location: docs/eip/api-ref link: /api-ref/elastic-ip/ pdf_name: eip-api-ref rst_location: api-ref/source service_type: eip title: API Reference type: api-ref - - html_location: docs/eip/umn + - hc_location: usermanual/eip + html_location: docs/eip/umn link: /umn/elastic-ip/ pdf_name: eip-umn rst_location: umn/source service_type: eip title: User Guide type: umn - - html_location: docs/elb/api-ref + - hc_location: api/elb + html_location: docs/elb/api-ref link: /api-ref/elastic-load-balancing/ pdf_name: elb-api-ref rst_location: api-ref/source service_type: elb title: API Reference type: api-ref - - html_location: docs/elb/umn + - hc_location: usermanual/elb + html_location: docs/elb/umn link: /umn/elastic-load-balancing/ pdf_name: elb-umn rst_location: umn/source service_type: elb title: User Guide type: umn - - html_location: docs/evs/api-ref + - hc_location: api/evs + html_location: docs/evs/api-ref link: /api-ref/elastic-volume-service/ pdf_name: evs-api-ref rst_location: api-ref/source service_type: evs title: API Reference type: api-ref - - html_location: docs/evs/dev + - hc_location: devg/evs + html_location: docs/evs/dev link: /dev/elastic-volume-service/ pdf_name: evs-dev-guide rst_location: dev_guide/source service_type: evs title: Developer Guide type: dev - - html_location: docs/evs/umn + - hc_location: usermanual/evs + html_location: docs/evs/umn link: /umn/elastic-volume-service/ pdf_name: evs-umn rst_location: umn/source service_type: evs title: User Guide type: umn - - html_location: docs/gaussdb_mysql/api-ref + - environment: internal + hc_location: api/gaussdb_mysql + html_location: docs/gaussdb_mysql/api-ref link: /api-ref/gaussdb-mysql/ pdf_name: gaussdb_mysql-api-ref rst_location: api-ref/source service_type: gaussdb_mysql title: API Reference type: api-ref - - html_location: docs/gaussdb_mysql/umn + - environment: internal + hc_location: usermanual/gaussdb_mysql + html_location: docs/gaussdb_mysql/umn link: /umn/gaussdb-mysql/ pdf_name: gaussdb_mysql-umn rst_location: umn/source service_type: gaussdb_mysql title: User Guide type: umn - - html_location: docs/gaussdb_nosql/umn + - environment: internal + hc_location: usermanual/gaussdb_nosql + html_location: docs/gaussdb_nosql/umn link: /umn/gaussdb-nosql/ pdf_name: gauss_nosql rst_location: umn/source service_type: gaussdb_nosql title: User Guide type: umn - - html_location: docs/iam/api-ref + - hc_location: api/iam + html_location: docs/iam/api-ref link: /api-ref/identity-access-management/ pdf_name: iam-api-ref rst_location: api-ref/source service_type: iam title: API Reference type: api-ref - - html_location: docs/iam/umn + - hc_location: usermanual/iam + html_location: docs/iam/umn link: /umn/identity-access-management/ pdf_name: iam-umn rst_location: umn/source service_type: iam title: User Guide type: umn - - html_location: docs/ims/api-ref + - hc_location: api/ims + html_location: docs/ims/api-ref link: /api-ref/image-management-service/ pdf_name: ims-api-ref rst_location: api-ref/source service_type: ims title: API Reference type: api-ref - - html_location: docs/ims/dev + - hc_location: devg/ims + html_location: docs/ims/dev link: /dev/image-management-service/ pdf_name: ims-dev-guide rst_location: dev_guide/source @@ -439,336 +504,387 @@ documents: rst_location: docs/ims/public-images service_type: ims title: Public Image Introduction - - html_location: docs/ims/umn + - hc_location: usermanual/ims + html_location: docs/ims/umn link: /umn/image-management-service/ pdf_name: ims-umn rst_location: umn/source service_type: ims title: User Guide type: umn - - html_location: docs/kms/api-ref + - hc_location: api/kms + html_location: docs/kms/api-ref link: /api-ref/key-management-service/ pdf_name: kms-api-ref rst_location: api-ref/source service_type: kms title: API Reference type: api-ref - - html_location: docs/kms/umn + - hc_location: usermanual/kms + html_location: docs/kms/umn link: /umn/key-management-service/ pdf_name: kms-umn rst_location: umn/source service_type: kms title: User Guide type: umn - - html_location: docs/lts/api-ref + - hc_location: api/lts + html_location: docs/lts/api-ref link: /api-ref/log-tank-service/ pdf_name: lts-api-ref rst_location: api-ref/source service_type: lts title: API Reference type: api-ref - - html_location: docs/lts/umn + - hc_location: usermanual/lts + html_location: docs/lts/umn link: /umn/log-tank-service/ pdf_name: lts-umn rst_location: umn/source service_type: lts title: User Guide type: umn - - html_location: docs/modelarts/api-ref + - hc_location: api/ma + html_location: docs/modelarts/api-ref link: /api-ref/modelarts/ pdf_name: ma-api-ref rst_location: api-ref/source service_type: ma title: API Reference type: api-ref - - html_location: docs/modelarts/umn + - hc_location: usermanual/ma + html_location: docs/modelarts/umn link: /umn/modelarts/ pdf_name: ma-umn rst_location: umn/source service_type: ma title: User Guide type: umn - - html_location: docs/mrs/api-ref + - hc_location: api/mrs + html_location: docs/mrs/api-ref link: /api-ref/mapreduce-service/ pdf_name: mrs-api-ref rst_location: api-ref/source service_type: mrs title: API Reference type: api-ref - - html_location: docs/mrs/component-operation-guide + - hc_location: cmpntguide/mrs + html_location: docs/mrs/component-operation-guide pdf_name: mrs-component-operation-guide rst_location: docs/mrs/component-operation-guide service_type: mrs title: Component Operation Guide - - html_location: docs/mrs/umn + - hc_location: usermanual/mrs + html_location: docs/mrs/umn link: /umn/mapreduce-service/ pdf_name: mrs-umn rst_location: umn/source service_type: mrs title: User Guide type: umn - - html_location: docs/natgw/api-ref + - hc_location: api/natgw + html_location: docs/natgw/api-ref link: /api-ref/nat-gateway/ pdf_name: natgw-api-ref rst_location: api-ref/source service_type: natgw title: API Reference type: api-ref - - html_location: docs/natgw/umn + - hc_location: usermanual/natgw + html_location: docs/natgw/umn link: /umn/nat-gateway/ pdf_name: natgw-umn rst_location: umn/source service_type: natgw title: User Guide type: umn - - html_location: docs/obs/api-ref + - hc_location: api/obs + html_location: docs/obs/api-ref link: /api-ref/object-storage-service/ pdf_name: obs-api-ref rst_location: api-ref/source service_type: obs title: API Reference type: api-ref - - html_location: docs/obs/dev + - hc_location: devg/obs + html_location: docs/obs/dev link: /dev/object-storage-service/ pdf_name: obs-dev-guide rst_location: dev_guide/source service_type: obs title: Developer Guide type: dev - - html_location: docs/obs/s3api + - hc_location: api_obs/obs + html_location: docs/obs/s3api pdf_name: obs-s3api rst_location: doc/s3api/source service_type: obs title: S3 API Reference - doc_type: s3cmd + hc_location: ugs3cmd/obs html_location: docs/obs/s3cmd pdf_name: obs-s3cmd rst_location: doc/s3cmd/source service_type: obs title: Third-Party Client (s3cmd) - - html_location: docs/obs/umn + - hc_location: usermanual/obs + html_location: docs/obs/umn link: /umn/object-storage-service/ pdf_name: obs-umn rst_location: umn/source service_type: obs title: User Guide type: umn - - html_location: docs/opengauss/api-ref + - environment: internal + hc_location: api/opengauss + html_location: docs/opengauss/api-ref link: /api-ref/gaussdb-opengauss/ pdf_name: opengauss-api-ref rst_location: api-ref/source service_type: opengauss title: API Reference type: api-ref - - html_location: docs/opengauss/umn + - environment: internal + hc_location: usermanual/opengauss + html_location: docs/opengauss/umn link: /umn/gaussdb-opengauss/ pdf_name: opengauss-umn rst_location: umn/source service_type: opengauss title: User Guide type: umn - - html_location: docs/plas/api-ref + - hc_location: api/plas + html_location: docs/plas/api-ref link: /api-ref/private-link-access-service/ pdf_name: plas-api-ref rst_location: api-ref/source service_type: plas title: API Reference type: api-ref - - html_location: docs/plas/umn + - hc_location: usermanual/plas + html_location: docs/plas/umn link: /umn/private-link-access-service/ pdf_name: plas-umn rst_location: umn/source service_type: plas title: User Guide type: umn - - html_location: docs/rds/api-ref + - hc_location: api/rds + html_location: docs/rds/api-ref link: /api-ref/relational-database-service/ pdf_name: rds-api-ref rst_location: api-ref/source service_type: rds title: API Reference type: api-ref - - html_location: docs/rds/umn + - hc_location: usermanual/rds + html_location: docs/rds/umn link: /umn/relational-database-service/ pdf_name: rds-umn rst_location: umn/source service_type: rds title: User Guide type: umn - - html_location: docs/rms/api-ref + - hc_location: api/rms + html_location: docs/rms/api-ref link: /api-ref/resource-management-service/ pdf_name: rms-api-ref rst_location: api-ref/source service_type: rms title: API Reference type: api-ref - - html_location: docs/rms/umn + - hc_location: usermanual/rms + html_location: docs/rms/umn link: /umn/resource-management-service/ pdf_name: rms-umn rst_location: umn/source service_type: rms title: User Guide type: umn - - html_location: docs/rts/api-ref + - hc_location: api/rts + html_location: docs/rts/api-ref link: /api-ref/resource-template-service/ pdf_name: rts-api-ref rst_location: api-ref/source service_type: rts title: API Reference type: api-ref - - html_location: docs/rts/umn + - hc_location: usermanual/rts + html_location: docs/rts/umn link: /umn/resource-template-service/ pdf_name: rts-umn rst_location: umn/source service_type: rts title: User Guide type: umn - - html_location: docs/sd/umn + - hc_location: usermanual/sd + html_location: docs/sd/umn link: /umn/status-dashboard/ pdf_name: sd-umn rst_location: umn/source service_type: sd title: User Guide type: umn - - html_location: docs/sdrs/api-ref + - hc_location: api/sdrs + html_location: docs/sdrs/api-ref link: /api-ref/storage-disaster-recovery-service/ pdf_name: sdrs-api-ref rst_location: api-ref/source service_type: sdrs title: API Reference type: api-ref - - html_location: docs/sdrs/umn + - hc_location: usermanual/sdrs + html_location: docs/sdrs/umn link: /umn/storage-disaster-recovery-service/ pdf_name: sdrs-umn rst_location: umn/source service_type: sdrs title: User Guide type: umn - - html_location: docs/sfs/api-ref + - hc_location: api/sfs + html_location: docs/sfs/api-ref link: /api-ref/scalable-file-service/ pdf_name: sfs-api-ref rst_location: api-ref/source service_type: sfs title: API Reference type: api-ref - - html_location: docs/sfs/cli + - hc_location: api_cli/sfs + html_location: docs/sfs/cli pdf_name: sfs-cli rst_location: doc/cli/source service_type: sfs title: Manila Client Reference - - html_location: docs/sfs/umn + - hc_location: usermanual/sfs + html_location: docs/sfs/umn link: /umn/scalable-file-service/ pdf_name: sfs-umn rst_location: umn/source service_type: sfs title: User Guide type: umn - - html_location: docs/smn/api-ref + - hc_location: api/smn + html_location: docs/smn/api-ref link: /api-ref/simple-message-notification/ pdf_name: smn-api-ref rst_location: api-ref/source service_type: smn title: API Reference type: api-ref - - html_location: docs/smn/umn + - hc_location: usermanual/smn + html_location: docs/smn/umn link: /umn/simple-message-notification/ pdf_name: smn-umn rst_location: umn/source service_type: smn title: User Guide type: umn - - html_location: docs/swr/api-ref + - hc_location: api/swr + html_location: docs/swr/api-ref link: /api-ref/software-repository-container/ pdf_name: swr-api-ref rst_location: api-ref/source service_type: swr title: API Reference type: api-ref - - html_location: docs/swr/umn + - hc_location: usermanual/swr + html_location: docs/swr/umn link: /umn/software-repository-container/ pdf_name: swr-umn rst_location: umn/source service_type: swr title: User Guide type: umn - - html_location: docs/tms/api-ref + - hc_location: api/tms + html_location: docs/tms/api-ref link: /api-ref/tag-management-service/ pdf_name: tms-api-ref rst_location: api-ref/source service_type: tms title: API Reference type: api-ref - - html_location: docs/tms/umn + - hc_location: usermanual/tms + html_location: docs/tms/umn link: /umn/tag-management-service/ pdf_name: tms-umn rst_location: umn/source service_type: tms title: User Guide type: umn - - html_location: docs/vbs/api-ref + - hc_location: api/vbs + html_location: docs/vbs/api-ref link: /api-ref/volume-backup-service/ pdf_name: vbs-api-ref rst_location: api-ref/source service_type: vbs title: API Reference type: api-ref - - html_location: docs/vbs/umn + - hc_location: usermanual/vbs + html_location: docs/vbs/umn link: /umn/volume-backup-service/ pdf_name: vbs-umn rst_location: umn/source service_type: vbs title: User Guide type: umn - - html_location: docs/vpc/api-ref + - hc_location: api/vpc + html_location: docs/vpc/api-ref link: /api-ref/virtual-private-cloud/ pdf_name: vpc-api-ref rst_location: api-ref/source service_type: vpc title: API Reference type: api-ref - - html_location: docs/vpc/umn + - hc_location: usermanual/vpc + html_location: docs/vpc/umn link: /umn/virtual-private-cloud/ pdf_name: vpc-umn rst_location: umn/source service_type: vpc title: User Guide type: umn - - html_location: docs/vpcep/api-ref + - hc_location: api/vpcep + html_location: docs/vpcep/api-ref link: /api-ref/vpc-endpoint/ pdf_name: vpcep-api-ref rst_location: api-ref/source service_type: vpcep title: API Reference type: api-ref - - html_location: docs/vpcep/umn + - hc_location: usermanual/vpcep + html_location: docs/vpcep/umn link: /umn/vpc-endpoint/ pdf_name: vpcep-umn rst_location: umn/source service_type: vpcep title: User Guide type: umn - - html_location: docs/vpn/api-ref + - hc_location: api/vpn + html_location: docs/vpn/api-ref link: /api-ref/virtual-private-network/ pdf_name: vpn-api-ref rst_location: api-ref/source service_type: vpn title: API Reference type: api-ref - - html_location: docs/vpn/umn + - hc_location: usermanual/vpn + html_location: docs/vpn/umn link: /umn/virtual-private-network/ pdf_name: vpn-umn rst_location: umn/source service_type: vpn title: User Guide type: umn - - html_location: docs/waf/api-ref + - hc_location: api/waf + html_location: docs/waf/api-ref link: /api-ref/web-application-firewall/ pdf_name: waf-api-ref rst_location: api-ref/source service_type: waf title: API Reference type: api-ref - - html_location: docs/waf/umn + - hc_location: usermanual/waf + html_location: docs/waf/umn link: /umn/web-application-firewall/ pdf_name: waf-umn rst_location: umn/source @@ -776,6 +892,7 @@ documents: title: User Guide type: umn - environment: internal + hc_location: api/wafd html_location: docs/wafd/api-ref link: /api-ref/web-application-firewall-dedicated/ pdf_name: wafd-api-ref @@ -784,6 +901,7 @@ documents: title: API Reference type: api-ref - environment: internal + hc_location: usermanual/wafd html_location: docs/wafd/umn link: /umn/web-application-firewall-dedicated/ pdf_name: wafd-umn @@ -1164,7 +1282,7 @@ services: repo: opentelekomcloud-docs/gaussdb-mysql type: github service_category: database - service_title: "GaussDB Enterprise-class Distributed Database compatible with MySQL" + service_title: GaussDB Enterprise-class Distributed Database compatible with MySQL service_type: gaussdb_mysql teams: - name: docs-database-rw @@ -1294,7 +1412,7 @@ services: repo: opentelekomcloud-docs/gaussdb-opengauss type: github service_category: database - service_title: "GaussDB Enterprise-grade Relational Database on the openGauss ecosystem" + service_title: GaussDB Enterprise-grade Relational Database on the openGauss ecosystem service_type: opengauss teams: - name: docs-database-rw diff --git a/otc_metadata/services.py b/otc_metadata/services.py index 35edb9b4..9fa4ad78 100644 --- a/otc_metadata/services.py +++ b/otc_metadata/services.py @@ -16,20 +16,18 @@ import warnings import otc_metadata.data -__all__ = ['Services'] +__all__ = ["Services"] -BUILTIN_DATA = otc_metadata.data.read_data('services.yaml') +BUILTIN_DATA = otc_metadata.data.read_data("services.yaml") def _normalize_type(service_type): if service_type: - return service_type.replace('_', '-') + return service_type.replace("_", "-") class Services(object): - """Encapsulation of the OTC Services data - - """ + """Encapsulation of the OTC Services data""" def __init__(self): self._service_data = BUILTIN_DATA @@ -37,38 +35,31 @@ class Services(object): def _sort_data(self): # Sort every doc item by key sorted_docs = [] - for doc in self._service_data['documents']: - sorted_docs.append(dict(sorted( - doc.items(), - key=lambda kv: kv[0] - ))) + for doc in self._service_data["documents"]: + sorted_docs.append(dict(sorted(doc.items(), key=lambda kv: kv[0]))) # sort docs list by _ - self._service_data['documents'] = sorted( - sorted_docs, - key=lambda x: f"{x.get('service_type')}{x.get('title')}" + self._service_data["documents"] = sorted( + sorted_docs, key=lambda x: f"{x.get('service_type')}{x.get('title')}" ) # sort services by <service_type>_<service_title> - self._service_data['services'] = sorted( - self._service_data['services'], - key=lambda x: f"{x.get('service_type')}{x.get('service_title')}" + self._service_data["services"] = sorted( + self._service_data["services"], + key=lambda x: f"{x.get('service_type')}{x.get('service_title')}", ) def _rewrite_data(self): - otc_metadata.data.rewrite_data( - "services.yaml", - self._service_data - ) + otc_metadata.data.rewrite_data("services.yaml", self._service_data) @property def all_services(self): "Service Categories data listing." - return copy.deepcopy(self._service_data['services']) + return copy.deepcopy(self._service_data["services"]) @property def all_docs(self): "Service Docs data listing." - return copy.deepcopy(self._service_data['documents']) + return copy.deepcopy(self._service_data["documents"]) @property def service_dict(self): @@ -80,21 +71,17 @@ class Services(object): @property def service_categories(self): - """List services categories - - """ + """List services categories""" res = [] for cat in self._service_data["service_categories"]: res.append(copy.deepcopy(cat)) return res def services_by_category(self, category): - """List services matching category - - """ + """List services matching category""" res = [] for srv in self.all_services: - if srv['service_category'] == category: + if srv["service_category"] == category: res.append(copy.deepcopy(srv)) return res @@ -162,9 +149,7 @@ class Services(object): yield copy.deepcopy(doc) def all_docs_full(self, environment): - """Return list or documents with full service data - - """ + """Return list or documents with full service data""" services = self.service_dict for doc in self.all_docs: if not doc["service_type"] in services: @@ -183,23 +168,22 @@ class Services(object): yield res_doc def docs_html_by_category(self, environment): - """Generate structure for doc-exports repository - - """ + """Generate structure for doc-exports repository""" doc_struct = dict() for srv in self.all_services: doc_struct.setdefault(srv["service_category"], []) srv_res = dict( - service_title=srv['service_title'], - service_type=srv['service_type'], - docs=[] + service_title=srv["service_title"], + service_type=srv["service_type"], + docs=[], ) + if "teams" in srv: + srv_res["teams"] = [ + x for x in srv["teams"] if x["permission"] == "write" + ] if "repositories" in srv and environment: for repo in srv["repositories"]: - if ( - "environment" in repo - and repo["environment"] == environment - ): + if "environment" in repo and repo["environment"] == environment: srv_res["repository"] = repo["repo"] for doc in self.all_docs: if ( @@ -211,8 +195,10 @@ class Services(object): rst_location=doc["rst_location"], title=doc["title"], type=doc.get("type", "dummy"), - pdf_name=doc["pdf_name"] + pdf_name=doc["pdf_name"], ) + if "hc_location" in doc: + doc_res["hc_location"] = doc["hc_location"] srv_res["docs"].append(doc_res) if len(srv_res["docs"]) > 0: doc_struct[srv["service_category"]].append(srv_res) diff --git a/tools/generate_docexports_data.py b/tools/generate_docexports_data.py index 90ce0dd9..4c76aaf1 100644 --- a/tools/generate_docexports_data.py +++ b/tools/generate_docexports_data.py @@ -13,9 +13,9 @@ def main(): _yaml = YAML() _yaml.indent(mapping=2, sequence=4, offset=2) - filepath = sys.stdout - sys.stdout.write('# Auto-generated by otc_metadata.generate_docexports.data\n') - _yaml.dump(data.docs_html_by_category('internal'), sys.stdout) + sys.stdout.write("# Auto-generated by otc_metadata.generate_docexports.data\n") + _yaml.dump(data.docs_html_by_category("internal"), sys.stdout) -if __name__ == '__main__': + +if __name__ == "__main__": main()