From 09ed761a98584fb7852103993f70cad3263443f3 Mon Sep 17 00:00:00 2001 From: "Goncharov, Artem" Date: Fri, 12 Aug 2022 16:24:57 +0000 Subject: [PATCH] Add docs placeholders Reviewed-by: gtema Co-authored-by: Goncharov, Artem Co-committed-by: Goncharov, Artem --- docs/antiddos/api-ref/.placeholder | 0 docs/antiddos/umn/.placeholder | 0 docs/aom/api-ref/.placeholder | 0 docs/aom/umn/.placeholder | 0 docs/as/api-ref/.placeholder | 0 docs/as/dev/.placeholder | 0 docs/as/umn/.placeholder | 0 docs/bms/api-ref/.placeholder | 0 docs/bms/dev/.placeholder | 0 docs/bms/umn/.placeholder | 0 docs/cbr/api-ref/.placeholder | 0 docs/cbr/umn/.placeholder | 0 docs/cce/api-ref/.placeholder | 0 docs/cce/umn/.placeholder | 0 docs/cdn/umn/.placeholder | 0 docs/ces/api-ref/.placeholder | 0 docs/ces/umn/.placeholder | 0 docs/csbs/api-ref/.placeholder | 0 docs/csbs/umn/.placeholder | 0 docs/css/api-ref/.placeholder | 0 docs/css/umn/.placeholder | 0 docs/cts/api-ref/.placeholder | 0 docs/cts/umn/.placeholder | 0 docs/dc/api-ref/.placeholder | 0 docs/dc/umn/.placeholder | 0 docs/dcs/api-ref/.placeholder | 0 docs/dcs/umn/.placeholder | 0 docs/dds/api-ref/.placeholder | 0 docs/dds/umn/.placeholder | 0 docs/deh/api-ref/.placeholder | 0 docs/deh/umn/.placeholder | 0 docs/dis/api-ref/.placeholder | 0 docs/dis/umn/.placeholder | 0 docs/dms/api-ref/.placeholder | 0 docs/dms/dev/.placeholder | 0 docs/dms/umn/.placeholder | 0 docs/dns/api-ref/.placeholder | 0 docs/dns/umn/.placeholder | 0 docs/dws/api-ref/.placeholder | 0 docs/dws/umn/.placeholder | 0 docs/eip/api-ref/.placeholder | 0 docs/eip/umn/.placeholder | 0 docs/evs/api-ref/.placeholder | 0 docs/evs/dev/.placeholder | 0 docs/evs/umn/.placeholder | 0 docs/iam/api-ref/.placeholder | 0 docs/iam/umn/.placeholder | 0 docs/ims/api-ref/.placeholder | 0 docs/ims/dev/.placeholder | 0 docs/kms/api-ref/.placeholder | 0 docs/kms/umn/.placeholder | 0 docs/lts/api-ref/.placeholder | 0 docs/lts/umn/.placeholder | 0 docs/mrs/api-ref/.placeholder | 0 docs/mrs/umn/.placeholder | 0 docs/natgw/api-ref/.placeholder | 0 docs/natgw/umn/.placeholder | 0 docs/obs/api-ref/.placeholder | 0 docs/obs/s3api/.placeholder | 0 docs/obs/s3cmd/.placeholder | 0 docs/obs/umn/.placeholder | 0 docs/plas/api-ref/.placeholder | 0 docs/plas/umn/.placeholder | 0 docs/rds/api-ref/.placeholder | 0 docs/rds/umn/.placeholder | 0 docs/rts/api-ref/.placeholder | 0 docs/rts/umn/.placeholder | 0 docs/sdrs/api-ref/.placeholder | 0 docs/sdrs/umn/.placeholder | 0 docs/sfs/api-ref/.placeholder | 0 docs/sfs/cli/.placeholder | 0 docs/sfs/umn/.placeholder | 0 docs/smn/api-ref/.placeholder | 0 docs/smn/umn/.placeholder | 0 docs/swr/api-ref/.placeholder | 0 docs/swr/umn/.placeholder | 0 docs/tms/api-ref/.placeholder | 0 docs/tms/umn/.placeholder | 0 docs/vbs/api-ref/.placeholder | 0 docs/vbs/umn/.placeholder | 0 docs/vpc/api-ref/.placeholder | 0 docs/vpc/umn/.placeholder | 0 docs/vpce/api-ref/.placeholder | 0 docs/vpce/umn/.placeholder | 0 docs/vpn/api-ref/.placeholder | 0 docs/vpn/umn/.placeholder | 0 docs/waf/api-ref/.placeholder | 0 docs/waf/umn/.placeholder | 0 docs_big-data.yaml | 18 - docs_compute.yaml | 34 -- metadata.yaml | 628 +++++++++++++++++++++++ playbooks/post.yaml | 17 +- playbooks/run.yaml | 40 +- playbooks/vars/metadata.yaml | 1 + roles/fetch_doc_artifacts/tasks/doc.yaml | 4 +- zuul.yaml | 6 +- 96 files changed, 670 insertions(+), 78 deletions(-) create mode 100644 docs/antiddos/api-ref/.placeholder create mode 100644 docs/antiddos/umn/.placeholder create mode 100644 docs/aom/api-ref/.placeholder create mode 100644 docs/aom/umn/.placeholder create mode 100644 docs/as/api-ref/.placeholder create mode 100644 docs/as/dev/.placeholder create mode 100644 docs/as/umn/.placeholder create mode 100644 docs/bms/api-ref/.placeholder create mode 100644 docs/bms/dev/.placeholder create mode 100644 docs/bms/umn/.placeholder create mode 100644 docs/cbr/api-ref/.placeholder create mode 100644 docs/cbr/umn/.placeholder create mode 100644 docs/cce/api-ref/.placeholder create mode 100644 docs/cce/umn/.placeholder create mode 100644 docs/cdn/umn/.placeholder create mode 100644 docs/ces/api-ref/.placeholder create mode 100644 docs/ces/umn/.placeholder create mode 100644 docs/csbs/api-ref/.placeholder create mode 100644 docs/csbs/umn/.placeholder create mode 100644 docs/css/api-ref/.placeholder create mode 100644 docs/css/umn/.placeholder create mode 100644 docs/cts/api-ref/.placeholder create mode 100644 docs/cts/umn/.placeholder create mode 100644 docs/dc/api-ref/.placeholder create mode 100644 docs/dc/umn/.placeholder create mode 100644 docs/dcs/api-ref/.placeholder create mode 100644 docs/dcs/umn/.placeholder create mode 100644 docs/dds/api-ref/.placeholder create mode 100644 docs/dds/umn/.placeholder create mode 100644 docs/deh/api-ref/.placeholder create mode 100644 docs/deh/umn/.placeholder create mode 100644 docs/dis/api-ref/.placeholder create mode 100644 docs/dis/umn/.placeholder create mode 100644 docs/dms/api-ref/.placeholder create mode 100644 docs/dms/dev/.placeholder create mode 100644 docs/dms/umn/.placeholder create mode 100644 docs/dns/api-ref/.placeholder create mode 100644 docs/dns/umn/.placeholder create mode 100644 docs/dws/api-ref/.placeholder create mode 100644 docs/dws/umn/.placeholder create mode 100644 docs/eip/api-ref/.placeholder create mode 100644 docs/eip/umn/.placeholder create mode 100644 docs/evs/api-ref/.placeholder create mode 100644 docs/evs/dev/.placeholder create mode 100644 docs/evs/umn/.placeholder create mode 100644 docs/iam/api-ref/.placeholder create mode 100644 docs/iam/umn/.placeholder create mode 100644 docs/ims/api-ref/.placeholder create mode 100644 docs/ims/dev/.placeholder create mode 100644 docs/kms/api-ref/.placeholder create mode 100644 docs/kms/umn/.placeholder create mode 100644 docs/lts/api-ref/.placeholder create mode 100644 docs/lts/umn/.placeholder create mode 100644 docs/mrs/api-ref/.placeholder create mode 100644 docs/mrs/umn/.placeholder create mode 100644 docs/natgw/api-ref/.placeholder create mode 100644 docs/natgw/umn/.placeholder create mode 100644 docs/obs/api-ref/.placeholder create mode 100644 docs/obs/s3api/.placeholder create mode 100644 docs/obs/s3cmd/.placeholder create mode 100644 docs/obs/umn/.placeholder create mode 100644 docs/plas/api-ref/.placeholder create mode 100644 docs/plas/umn/.placeholder create mode 100644 docs/rds/api-ref/.placeholder create mode 100644 docs/rds/umn/.placeholder create mode 100644 docs/rts/api-ref/.placeholder create mode 100644 docs/rts/umn/.placeholder create mode 100644 docs/sdrs/api-ref/.placeholder create mode 100644 docs/sdrs/umn/.placeholder create mode 100644 docs/sfs/api-ref/.placeholder create mode 100644 docs/sfs/cli/.placeholder create mode 100644 docs/sfs/umn/.placeholder create mode 100644 docs/smn/api-ref/.placeholder create mode 100644 docs/smn/umn/.placeholder create mode 100644 docs/swr/api-ref/.placeholder create mode 100644 docs/swr/umn/.placeholder create mode 100644 docs/tms/api-ref/.placeholder create mode 100644 docs/tms/umn/.placeholder create mode 100644 docs/vbs/api-ref/.placeholder create mode 100644 docs/vbs/umn/.placeholder create mode 100644 docs/vpc/api-ref/.placeholder create mode 100644 docs/vpc/umn/.placeholder create mode 100644 docs/vpce/api-ref/.placeholder create mode 100644 docs/vpce/umn/.placeholder create mode 100644 docs/vpn/api-ref/.placeholder create mode 100644 docs/vpn/umn/.placeholder create mode 100644 docs/waf/api-ref/.placeholder create mode 100644 docs/waf/umn/.placeholder delete mode 100644 docs_big-data.yaml delete mode 100644 docs_compute.yaml create mode 100644 metadata.yaml create mode 120000 playbooks/vars/metadata.yaml diff --git a/docs/antiddos/api-ref/.placeholder b/docs/antiddos/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/antiddos/umn/.placeholder b/docs/antiddos/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/aom/api-ref/.placeholder b/docs/aom/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/aom/umn/.placeholder b/docs/aom/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/as/api-ref/.placeholder b/docs/as/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/as/dev/.placeholder b/docs/as/dev/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/as/umn/.placeholder b/docs/as/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/bms/api-ref/.placeholder b/docs/bms/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/bms/dev/.placeholder b/docs/bms/dev/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/bms/umn/.placeholder b/docs/bms/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/cbr/api-ref/.placeholder b/docs/cbr/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/cbr/umn/.placeholder b/docs/cbr/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/cce/api-ref/.placeholder b/docs/cce/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/cce/umn/.placeholder b/docs/cce/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/cdn/umn/.placeholder b/docs/cdn/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/ces/api-ref/.placeholder b/docs/ces/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/ces/umn/.placeholder b/docs/ces/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/csbs/api-ref/.placeholder b/docs/csbs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/csbs/umn/.placeholder b/docs/csbs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/css/api-ref/.placeholder b/docs/css/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/css/umn/.placeholder b/docs/css/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/cts/api-ref/.placeholder b/docs/cts/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/cts/umn/.placeholder b/docs/cts/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dc/api-ref/.placeholder b/docs/dc/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dc/umn/.placeholder b/docs/dc/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dcs/api-ref/.placeholder b/docs/dcs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dcs/umn/.placeholder b/docs/dcs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dds/api-ref/.placeholder b/docs/dds/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dds/umn/.placeholder b/docs/dds/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/deh/api-ref/.placeholder b/docs/deh/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/deh/umn/.placeholder b/docs/deh/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dis/api-ref/.placeholder b/docs/dis/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dis/umn/.placeholder b/docs/dis/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dms/api-ref/.placeholder b/docs/dms/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dms/dev/.placeholder b/docs/dms/dev/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dms/umn/.placeholder b/docs/dms/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dns/api-ref/.placeholder b/docs/dns/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dns/umn/.placeholder b/docs/dns/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dws/api-ref/.placeholder b/docs/dws/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/dws/umn/.placeholder b/docs/dws/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/eip/api-ref/.placeholder b/docs/eip/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/eip/umn/.placeholder b/docs/eip/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/evs/api-ref/.placeholder b/docs/evs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/evs/dev/.placeholder b/docs/evs/dev/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/evs/umn/.placeholder b/docs/evs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/iam/api-ref/.placeholder b/docs/iam/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/iam/umn/.placeholder b/docs/iam/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/ims/api-ref/.placeholder b/docs/ims/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/ims/dev/.placeholder b/docs/ims/dev/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/kms/api-ref/.placeholder b/docs/kms/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/kms/umn/.placeholder b/docs/kms/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/lts/api-ref/.placeholder b/docs/lts/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/lts/umn/.placeholder b/docs/lts/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/mrs/api-ref/.placeholder b/docs/mrs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/mrs/umn/.placeholder b/docs/mrs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/natgw/api-ref/.placeholder b/docs/natgw/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/natgw/umn/.placeholder b/docs/natgw/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/obs/api-ref/.placeholder b/docs/obs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/obs/s3api/.placeholder b/docs/obs/s3api/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/obs/s3cmd/.placeholder b/docs/obs/s3cmd/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/obs/umn/.placeholder b/docs/obs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/plas/api-ref/.placeholder b/docs/plas/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/plas/umn/.placeholder b/docs/plas/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/rds/api-ref/.placeholder b/docs/rds/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/rds/umn/.placeholder b/docs/rds/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/rts/api-ref/.placeholder b/docs/rts/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/rts/umn/.placeholder b/docs/rts/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/sdrs/api-ref/.placeholder b/docs/sdrs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/sdrs/umn/.placeholder b/docs/sdrs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/sfs/api-ref/.placeholder b/docs/sfs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/sfs/cli/.placeholder b/docs/sfs/cli/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/sfs/umn/.placeholder b/docs/sfs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/smn/api-ref/.placeholder b/docs/smn/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/smn/umn/.placeholder b/docs/smn/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/swr/api-ref/.placeholder b/docs/swr/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/swr/umn/.placeholder b/docs/swr/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/tms/api-ref/.placeholder b/docs/tms/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/tms/umn/.placeholder b/docs/tms/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vbs/api-ref/.placeholder b/docs/vbs/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vbs/umn/.placeholder b/docs/vbs/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vpc/api-ref/.placeholder b/docs/vpc/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vpc/umn/.placeholder b/docs/vpc/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vpce/api-ref/.placeholder b/docs/vpce/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vpce/umn/.placeholder b/docs/vpce/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vpn/api-ref/.placeholder b/docs/vpn/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/vpn/umn/.placeholder b/docs/vpn/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/waf/api-ref/.placeholder b/docs/waf/api-ref/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs/waf/umn/.placeholder b/docs/waf/umn/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/docs_big-data.yaml b/docs_big-data.yaml deleted file mode 100644 index 3fb61c9f..00000000 --- a/docs_big-data.yaml +++ /dev/null @@ -1,18 +0,0 @@ ---- -docs: - - label: ma_umn - service_type: ma - doc_type: umn - html_location: docs/modelarts/umn - repository: docs/modelarts - project_location: /umn/source - title: ModelArts - User Guide - service: ModelArts - - label: ma_api - service_type: ma - doc_type: api-ref - html_location: docs/modelarts/api-ref - repository: docs/modelarts - project_location: /api-ref/source - title: ModelArts - API Reference - service: ModelArts diff --git a/docs_compute.yaml b/docs_compute.yaml deleted file mode 100644 index 1f9fe13c..00000000 --- a/docs_compute.yaml +++ /dev/null @@ -1,34 +0,0 @@ ---- -docs: - - label: ecs_umn - service_type: ecs - doc_type: umn - html_location: docs/ecs/umn - repository: docs/elastic-cloud-server - project_location: /umn/source - title: Elastic Cloud Server - User Guide - service: Elastic Cloud Server - - label: ecs_api - service_type: ecs - doc_type: api-ref - html_location: docs/ecs/api-ref - repository: docs/elastic-cloud-server - project_location: /api-ref/source - title: Elastic Cloud Server - API Reference - service: Elastic Cloud Server - - label: ecs_dev - service_type: ecs - doc_type: dev-guide - html_location: docs/ecs/dev - repository: docs/elastic-cloud-server - project_location: /dev_guide/source - title: Elastic Cloud Server - Developer Guide - service: Elastic Cloud Server - - label: ims_umn - service_type: ims - doc_type: umn - html_location: docs/ims/umn - repository: docs/image-management-service - project_location: /umn/source - title: Image Management Service - User Guide - service: Image Management Service diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 00000000..013f2ba4 --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,628 @@ +--- +categories: + application: + # AOM + - service_title: Application Operations Management + repository: docs/application-operations-management + service_type: aom + docs: + - type: umn + html_location: docs/aom/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/aom/api-ref + rst_location: api-ref/source + title: API Reference + # DMS + - service_title: Distributed Message Service + repository: docs/distributed-message-service + service_type: dms + docs: + - type: umn + html_location: docs/dms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dms/api-ref + rst_location: api-ref/source + title: API Reference + # SMN + - service_title: Simple Message Notification + repository: docs/simple-message-notification + service_type: smn + docs: + - type: umn + html_location: docs/smn/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/smn/api-ref + rst_location: api-ref/source + title: API Reference + big_data: + # CSS + - service_title: Cloud Search Service + repository: docs/cloud-search-service + service_type: css + docs: + - type: umn + html_location: docs/css/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/css/api-ref + rst_location: api-ref/source + title: API Reference + # DIS + - service_title: Data Ingestion Service + repository: docs/data-ingestion-service + service_type: dis + docs: + - type: umn + html_location: docs/dis/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dis/api-ref + rst_location: api-ref/source + title: API Reference + # DWS + - service_title: Data Warehouse Service + repository: docs/data-ingestion-service + service_type: dws + docs: + - type: umn + html_location: docs/dws/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dws/api-ref + rst_location: api-ref/source + title: API Reference + # - type: dev-guide + # html_location: docs/dws/dev + # rst_location: dev_guide/source + # title: Developer Guide + # ModelArts + - service_title: ModelArts + repository: docs/modelarts + service_type: ma + docs: + - type: umn + html_location: docs/modelarts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/modelarts/api-ref + rst_location: api-ref/source + title: API Reference + # MRS + - service_title: Map Reduce Service + repository: docs/mapreduce-service + service_type: mrs + docs: + - type: umn + html_location: docs/mrs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/mrs/api-ref + rst_location: api-ref/source + title: API Reference + compute: + # AS + - service_title: Auto Scaling + repository: docs/auto-scaling + service_type: as + docs: + - type: umn + html_location: docs/as/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/as/api-ref + rst_location: api-ref/source + title: API Reference + # - type: dev-guide + # html_location: docs/as/dev + # rst_location: dev_guide/source + # title: Developer Guide + # BMS + - service_title: Bare Metal Server + repository: docs/bare-metal-server + service_type: bms + docs: + - type: umn + html_location: docs/bms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/bms/api-ref + rst_location: api-ref/source + title: API Reference + # - type: dev-guide + # html_location: docs/bms/dev + # rst_location: dev_guide/source + # title: Developer Guide + # DeH + - service_title: Dedicated Host + repository: docs/dedicated-host + service_type: deh + docs: + - type: umn + html_location: docs/deh/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/deh/api-ref + rst_location: api-ref/source + title: API Reference + # ECS + - service_title: Elastic Cloud Server + repository: docs/elastic-cloud-server + service_type: ecs + docs: + - type: umn + html_location: docs/ecs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/ecs/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/ecs/dev + rst_location: dev_guide/source + title: Developer Guide + # IMS + - service_title: Image Management Service + repository: docs/image-management-service + service_type: ims + docs: + - type: umn + html_location: docs/ims/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/ims/api-ref + rst_location: api-ref/source + title: API Reference + # - type: dev-guide + # html_location: docs/ims/dev + # rst_location: dev_guide/source + # title: Developer Guide + container: + # CCE + - service_title: Cloud Container Service + repository: docs/cloud-container-service + service_type: cce + docs: + - type: umn + html_location: docs/cce/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/cce/api-ref + rst_location: api-ref/source + title: API Reference + # SWR + - service_title: Software Repository for Containers + repository: docs/software-repository-container + service_type: swr + docs: + - type: umn + html_location: docs/swr/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/swr/api-ref + rst_location: api-ref/source + title: API Reference + database: + # DCS + - service_title: Distributed Cache Service + repository: docs/distributed-cache-service + service_type: dcs + docs: + - type: umn + html_location: docs/dcs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dcs/api-ref + rst_location: api-ref/source + title: API Reference + # DDS + - service_title: Document Database Service + repository: docs/document-database-service + service_type: dds + docs: + - type: umn + html_location: docs/dds/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dds/api-ref + rst_location: api-ref/source + title: API Reference + # RDS + - service_title: Relational Database Service + repository: docs/relational-database-service + service_type: rds + docs: + - type: umn + html_location: docs/rds/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/rds/api-ref + rst_location: api-ref/source + title: API Reference + md: + # Cloud Eye + - service_title: Cloud Eye + repository: docs/cloud-eye + service_type: ces + docs: + - type: umn + html_location: docs/ces/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/ces/api-ref + rst_location: api-ref/source + title: API Reference + # CTS + - service_title: Cloud Trace Service + repository: docs/cloud-trace-service + service_type: ces + docs: + - type: umn + html_location: docs/cts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/cts/api-ref + rst_location: api-ref/source + title: API Reference + # IAM + - service_title: Identity and Access Management + repository: docs/identity-access-management + service_type: iam + docs: + - type: umn + html_location: docs/iam/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/iam/api-ref + rst_location: api-ref/source + title: API Reference + # LTS + - service_title: Log Tank Service + repository: docs/log-tank-service + service_type: lts + docs: + - type: umn + html_location: docs/lts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/lts/api-ref + rst_location: api-ref/source + title: API Reference + # RTS + - service_title: Resource Template Service + repository: docs/resource-template-service + service_type: rts + docs: + - type: umn + html_location: docs/rts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/rts/api-ref + rst_location: api-ref/source + title: API Reference + # TMS + - service_title: Tag Management Service + repository: docs/tag-management-service + service_type: tms + docs: + - type: umn + html_location: docs/tms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/tms/api-ref + rst_location: api-ref/source + title: API Reference + network: + # CDN + - service_title: Content Delivery Network (Akamai) + repository: docs/content-delivery-network + service_type: cdn + docs: + - type: umn + html_location: docs/cdn/umn + rst_location: umn/source + title: User Guide + # DC + - service_title: Direct Connect + repository: docs/direct-connect + service_type: dc + docs: + - type: umn + html_location: docs/dc/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dc/api-ref + rst_location: api-ref/source + title: API Reference + # DNS + - service_title: Domain Name Service + repository: docs/domain-name-service + service_type: dns + docs: + - type: umn + html_location: docs/dns/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dns/api-ref + rst_location: api-ref/source + title: API Reference + # EIP + - service_title: Elastic IP + repository: docs/elastic-ip + service_type: eip + docs: + - type: umn + html_location: docs/eip/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/eip/api-ref + rst_location: api-ref/source + title: API Reference + # ELB + - service_title: Elastic Load Balancing + repository: docs/elastic-load-balancing + service_type: elb + docs: + - type: umn + html_location: docs/elb/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/elb/api-ref + rst_location: api-ref/source + title: API Reference + # NATGW + - service_title: NAT Gateway + repository: docs/nat-gateway + service_type: nat + docs: + - type: umn + html_location: docs/natgw/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/natgw/api-ref + rst_location: api-ref/source + title: API Reference + # PLAS + - service_title: Private Link Access + repository: docs/private-link-access-service + service_type: plas + docs: + - type: umn + html_location: docs/plas/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/plas/api-ref + rst_location: api-ref/source + title: API Reference + # VPC + - service_title: Virtual Private Cloud + repository: docs/virtual-private-cloud + service_type: vpc + docs: + - type: umn + html_location: docs/vpc/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vpc/api-ref + rst_location: api-ref/source + title: API Reference + # VPN + - service_title: Virtual Private Network + repository: docs/virtual-private-network + service_type: vpn + docs: + - type: umn + html_location: docs/vpn/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vpn/api-ref + rst_location: api-ref/source + title: API Reference + # VPCE + - service_title: VPC Endpoint + repository: docs/vpc-endpoint + service_type: vpce + docs: + - type: umn + html_location: docs/vpce/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vpce/api-ref + rst_location: api-ref/source + title: API Reference + security: + # Anti-DDoS + - service_title: Anti DDoS + repository: docs/anti-ddos + service_type: antiddos + docs: + - type: umn + html_location: docs/antiddos/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/antiddos/api-ref + rst_location: api-ref/source + title: API Reference + # KMS + - service_title: Key Management Service + repository: docs/key-management-service + service_type: kms + docs: + - type: umn + html_location: docs/kms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/kms/api-ref + rst_location: api-ref/source + title: API Reference + # WAF + - service_title: Web Application Firewall + repository: docs/web-application-firewall + service_type: waf + docs: + - type: umn + html_location: docs/waf/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/waf/api-ref + rst_location: api-ref/source + title: API Reference + # WAFD + - service_title: Dedicated Web Application Firewall + repository: docs/web-application-firewall-dedicated + service_type: waf + docs: + - type: umn + html_location: docs/wafd/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/wafd/api-ref + rst_location: api-ref/source + title: API Reference + storage: + # CBR + - service_title: Cloud Backup and Recovery + repository: docs/cloud-backup-recovery + service_type: cbr + docs: + - type: umn + html_location: docs/cbr/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/cbr/api-ref + rst_location: api-ref/source + title: API Reference + # CSBS + - service_title: Cloud Server Backup Service + repository: docs/cloud-server-backup-service + service_type: csbs + docs: + - type: umn + html_location: docs/csbs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/csbs/api-ref + rst_location: api-ref/source + title: API Reference + # EVS + - service_title: Elastic Volume Service + repository: docs/elastic-volume-service + service_type: evs + docs: + - type: umn + html_location: docs/evs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/evs/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/evs/dev + rst_location: dev_guide/source + title: Developer Guide + # OBS + - service_title: Object Storage Service + repository: docs/object-storage-service + service_type: obs + docs: + - type: umn + html_location: docs/obs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/obs/api-ref + rst_location: api-ref/source + title: API Reference + - type: s3api + html_location: docs/obs/s3api + rst_location: doc/s3api/source + title: S3 API Reference + - type: s3cmd + html_location: docs/obs/s3cmd + rst_location: doc/s3cmd/source + title: Third-Party Client (s3cmd) + # SDRS + - service_title: Storage Disaster Recovery Service + repository: docs/storage-disaster-recovery-service + service_type: sdrs + docs: + - type: umn + html_location: docs/sdrs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/sdrs/api-ref + rst_location: api-ref/source + title: API Reference + # SFS + - service_title: Scalable File System + repository: docs/scalable-file-system + service_type: sfs + docs: + - type: umn + html_location: docs/sfs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/sfs/api-ref + rst_location: api-ref/source + title: API Reference + - type: cli + html_location: docs/sfs/cli + rst_location: doc/cli/source + title: Manila Client Reference + # VBS + - service_title: Volume Backup Service + repository: docs/volume-backup-service + service_type: vbs + docs: + - type: umn + html_location: docs/vbs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vbs/api-ref + rst_location: api-ref/source + title: API Reference diff --git a/playbooks/post.yaml b/playbooks/post.yaml index d535a6f3..0bfc53c2 100644 --- a/playbooks/post.yaml +++ b/playbooks/post.yaml @@ -1,18 +1,15 @@ --- - hosts: all tasks: - - name: Read project docs configuration - include_vars: "{{ docs_update_data_file }}" - - name: Fetch generated artifacts - include_role: + ansible.builtin.include_role: name: "fetch_doc_artifacts" vars: - fetch_doc_artifacts_name: "{{ doc.label }}" - fetch_doc_artifacts_rst_source: "{{ ansible_user_dir }}/{{ doc.repository }}/{{ doc.project_location }}" - # fetch_doc_artifacts_diff_patch: "{{ ansible_user_dir }}/{{ doc.label }}.patch" - # fetch_doc_artifacts_git_patch: "{{ ansible_user_dir }}/{{ doc.label }}.git.patch" - loop: "{{ docs }}" + fetch_doc_artifacts_name: "{{ doc.0.service_type }}_{{ doc.1.type }}" + fetch_doc_artifacts_rst_source: "{{ ansible_user_dir }}/{{ doc.0.repository }}/{{ doc.1.rst_location }}" + fetch_doc_artifacts_doc_type: "{{ doc.1.type }}" + fetch_doc_artifacts_service: "{{ doc.0.service_type }}" + loop: "{{ doc_exports_var | subelements('docs') }}" loop_control: loop_var: "doc" - label: "{{ doc.label }}" + label: "{{ doc.0.service_type }}_{{ doc.1.type }}" diff --git a/playbooks/run.yaml b/playbooks/run.yaml index 2de251fb..1a520c89 100644 --- a/playbooks/run.yaml +++ b/playbooks/run.yaml @@ -2,25 +2,41 @@ - hosts: all tasks: - name: Read project docs configuration - include_vars: "{{ docs_update_data_file }}" + ansible.builtin.include_vars: "{{ docs_update_data_file }}" - name: Save doc var ansible.builtin.set_fact: - doc_exports_var: "{{ docs }}" + doc_exports_var: "{{ categories[docs_service_category] | default({}) }}" cacheable: true + - name: Detect list of changes + ansible.builtin.command: "git log -1 --name-only --pretty=" + args: + chdir: "{{ zuul.project.src_dir }}" + register: git_log + ignore_errors: true + changed_when: false + - name: Generate RSTs - include_role: + ansible.builtin.include_role: name: "convert_doc" vars: - doc_label: "{{ doc.label }}" - dest: "{{ ansible_user_dir }}/{{ doc.repository }}/{{ doc.project_location }}" - source: "{{ zuul.project.src_dir }}/{{ doc.html_location }}" - doc_title: "{{ doc.title | default(omit) }}" - doc_service: "{{ doc.service | default(omit) }}" - doc_repo_name: "{{ doc.repository | default(omit) }}" - doc_pdf_name: "{{ [doc.doc_type, doc.service_type] | join('-') }}" - loop: "{{ docs }}" + doc_label: "{{ doc.0.service_type }}_{{ doc.1.type }}" + dest: "{{ ansible_user_dir }}/{{ doc.0.repository }}/{{ doc.1.rst_location }}" + source: "{{ zuul.project.src_dir }}/{{ doc.1.html_location }}" + doc_title: "{{ [ doc.0.service_title, doc.1.title ] | join(' - ') }}" + doc_service: "{{ doc.0.service_title | default(omit) }}" + doc_repo_name: "{{ doc.0.repository | default(omit) }}" + doc_pdf_name: "{{ [ doc.1.type, doc.0.service_type ] | join('-') }}" + loop: "{{ doc_exports_var | subelements('docs') }}" loop_control: loop_var: "doc" - label: "{{ doc.label }}" + label: "{{ doc.0.service_type }}_{{ doc.1.type }}" + when: + - "doc.1.html_location is defined" + - "doc.1.rst_location is defined" + - | + git_log.stdout is search(doc.1.html_location) + or git_log.stdout is search('otc_doc_convertor') + or git_log.stdout is search('playbooks') + or git_log.stdout is search('templates') diff --git a/playbooks/vars/metadata.yaml b/playbooks/vars/metadata.yaml new file mode 120000 index 00000000..83aa5b6e --- /dev/null +++ b/playbooks/vars/metadata.yaml @@ -0,0 +1 @@ +../../metadata.yaml \ No newline at end of file diff --git a/roles/fetch_doc_artifacts/tasks/doc.yaml b/roles/fetch_doc_artifacts/tasks/doc.yaml index cb8f1461..dd8c3004 100644 --- a/roles/fetch_doc_artifacts/tasks/doc.yaml +++ b/roles/fetch_doc_artifacts/tasks/doc.yaml @@ -38,6 +38,6 @@ url: "{{ fetch_doc_artifacts_name }}.tar.gz" metadata: type: docs_archive - doc_service: "{{ doc.service_type }}" - doc_type: "{{ doc.doc_type }}" + doc_service: "{{ fetch_doc_artifacts_service }}" + doc_type: "{{ fetch_doc_artifacts_doc_type }}" doc_label: "{{ fetch_doc_artifacts_name }}" diff --git a/zuul.yaml b/zuul.yaml index 4fedf8ee..1667dc00 100644 --- a/zuul.yaml +++ b/zuul.yaml @@ -10,6 +10,8 @@ pre-run: playbooks/pre.yaml run: playbooks/run.yaml post-run: playbooks/post.yaml + vars: + docs_update_data_file: "metadata.yaml" - job: name: otc-doc-exports-convert-compute @@ -25,7 +27,7 @@ - templates provides: otc-doc-exports-convert-compute vars: - docs_update_data_file: "docs_compute.yaml" + docs_service_category: "compute" - job: name: otc-doc-exports-convert-big-data @@ -39,7 +41,7 @@ - roles - templates vars: - docs_update_data_file: "docs_big-data.yaml" + docs_service_category: "big_data" - project: merge-mode: squash-merge