Merge pull request 'Sync with original repository' (#1) from infra/otc-metadata:main into main

Reviewed-on: #1

otc_metadata/data/documents/ac-blueprints.yaml

@@ -6,3 +6,4 @@ rst_location: doc/blueprints/source
 service_type: ac
 title: Blueprints
 type: blueprints
+disable_import: true

otc_metadata/data/documents/ac-cloud-adoption-framework.yaml

@@ -6,3 +6,4 @@ rst_location: doc/caf/source
 service_type: ac
 title: Cloud Adoption Framework
 type: caf
+disable_import: true

otc_metadata/data/documents/asm-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: asm
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/blueprints-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: blueprints
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/cbr-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: cbr
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/cce-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: cce
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/config-api-ref.yaml

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: api/rms
+html_location: docs/config/api-ref
+link: /config/api-ref/
+pdf_name: config-api-ref
+rst_location: api-ref/source
+service_type: config
+title: API Reference
+type: api-ref

otc_metadata/data/documents/config-umn.yaml

@@ -0,0 +1,9 @@
+---
+environment: internal
+hc_location: usermanual/rms
+html_location: docs/config/umn
+link: /config/umn/
+rst_location: umn/source
+service_type: config
+title: User Guide
+type: umn

otc_metadata/data/documents/css-best-practice.yaml

@@ -7,3 +7,4 @@ rst_location: doc/best-practice/source
 service_type: css
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/dc-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: dc
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/dcs-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: dcs
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/dds-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: dds
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/dms-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: dms
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/dns-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: dns
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/drs-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: drs
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/ecs-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: ecs
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/elb-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: elb
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/evs-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: evs
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/fg-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: fg
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/geminidb-api-ref.yaml

@@ -1,6 +1,5 @@
 ---
 hc_location: api/nosql
-environment: internal
 html_location: docs/geminidb/api-ref
 link: /geminidb/api-ref/
 pdf_name: geminidb-api-ref

otc_metadata/data/documents/geminidb-umn.yaml

@@ -1,5 +1,4 @@
 ---
-environment: internal
 hc_location: usermanual/nosql
 html_location: docs/geminidb/umn
 link: /geminidb/umn/

otc_metadata/data/documents/iam-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: iam
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/iam-mycredential.yaml

@@ -6,3 +6,4 @@ rst_location: doc/mycredential/source
 service_type: iam
 title: My Credential
 type: mycredential
+disable_import: true

otc_metadata/data/documents/ims-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: ims
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/mkp-umn.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: usermanual/mkp
+html_location: docs/mkp/umn
+link: /marketplace/umn/
+pdf_name: mkp-umn
+rst_location: umn/source
+service_type: mkp
+title: User Guide
+type: umn
+disable_import: true

otc_metadata/data/documents/mrs-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: mrs
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/natgw-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: natgw
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/obs-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: obs
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/obs-swiftapi.yaml

@@ -1,4 +1,5 @@
 ---
+environment: internal
 hc_location: api_swift/obs
 html_location: docs/obs/api-swift
 link: /object-storage-service/swiftapi/

otc_metadata/data/documents/rfs-api-ref.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: api/rfs
+environment: internal
+html_location: docs/rfs/api-ref
+link: /resource-formation-service/api-ref/
+pdf_name: rfs-api-ref
+rst_location: api-ref/source
+service_type: rfs
+title: API Reference
+type: api-ref

otc_metadata/data/documents/rfs-umn.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: usermanual/aos
+environment: internal
+html_location: docs/rfs/umn
+link: /resource-formation-service/umn/
+pdf_name: rfs-umn
+rst_location: umn/source
+service_type: rfs
+title: User Guide
+type: umn

otc_metadata/data/documents/sfs-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: sfs
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/smg-umn.yaml

@@ -6,3 +6,4 @@ rst_location: umn/source
 service_type: smg
 title: User Guide
 type: umn
+disable_import: true

otc_metadata/data/documents/swr-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: swr
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/tms-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: tms
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/vpc-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: vpc
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/documents/wafd-best-practice.yaml

@@ -8,3 +8,4 @@ rst_location: doc/best-practice/source
 service_type: wafd
 title: Best Practice
 type: best-practice
+disable_import: true

otc_metadata/data/services/antiddos.yaml

@@ -8,7 +8,7 @@ repositories:
   repo: opentelekomcloud-docs/anti-ddos
   type: github
 service_category: security-services
-service_title: Anti DDoS
+service_title: Anti-DDoS
 service_type: antiddos
 service_uri: anti-ddos
 teams:

otc_metadata/data/services/config.yaml

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/config
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/config
+  type: github
+service_category: md
+service_title: Config
+service_type: config
+service_uri: config
+teams:
+- name: docs-orchestration-rw
+  permission: write

otc_metadata/data/services/geminidb.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/geminidb

otc_metadata/data/services/mkp.yaml

@@ -0,0 +1,16 @@
+---
+environment: public
+repositories:
+- environment: internal
+  repo: docs/marketplace
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/marketplace
+  type: github
+service_category: other
+service_title: Marketplace
+service_type: mkp
+service_uri: marketplace
+teams:
+- name: docs-3rd-party-integration-rw
+  permission: write

otc_metadata/data/services/notfound.yaml

@@ -0,0 +1,13 @@
+---
+environment: hidden
+repositories:
+- environment: public
+  repo: opentelekomcloud-docs/page-not-found
+  type: github
+service_category: other
+service_title: Page Not Found
+service_type: pagenotfound
+service_uri: page-not-found
+teams:
+- name: docs-eco-rw
+  permission: write

otc_metadata/data/services/rfs.yaml

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/resource-formation-service
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/resource-formation-service
+  type: github
+service_category: application
+service_title: Resource Formation Service
+service_type: rfs
+service_uri: resource-formation-service
+teams:
+- name: docs-orchestration-rw
+  permission: write

otc_metadata/services.py

@@ -278,6 +278,10 @@ class Services(object):
                         doc_res["pdf_name"] = doc["pdf_name"]
                     if "hc_location" in doc:
                         doc_res["hc_location"] = doc["hc_location"]
+                    if "disable_import" in doc:
+                        doc_res["disable_import"] = doc["disable_import"]
+                    else:
+                        doc_res["disable_import"] = False
                     srv_res["docs"].append(doc_res)
             if len(srv_res["docs"]) > 0:
                 doc_struct[srv["service_category"]].append(srv_res)

otc_metadata/templates/index_sbv.rst.j2

@@ -5,3 +5,4 @@
 
    .. service_card::
       :service_type: {{ service_type }}
+      :environment: {{ environment }}

tools/generate_doc_confpy.py

@@ -201,6 +201,7 @@ def process_repositories(args, service):
                 site_name="Internal Documentation Portal",
                 logo_url="https://docs-int.otc-service.com",
             )
+        context["environment"] = args.target_environment
         sbv_title = (service["service_title"] + "\n"
                      + ('=' * len(service["service_title"])))
         context["sbv_title"] = sbv_title

tools/generate_docexports_data.py

@@ -12,12 +12,26 @@ def main():
     data = otc_metadata.services.Services()
     data._sort_data()
 
+    docs = data.docs_html_by_category("internal")
+
+    # Filter out documents with "disable_import": True
+    for category, services in docs['categories'].items():
+        for service in services:
+            filtered_docs = []
+
+            for doc in service['docs']:
+                # Check if the document doesnt have 'disable_import' on True
+                if not doc.get('disable_import'):
+                    filtered_docs.append(doc)
+
+            service['docs'] = filtered_docs
+
     _yaml = YAML()
     _yaml.indent(mapping=2, sequence=4, offset=2)
     sys.stdout.write(
         "# Auto-generated by otc_metadata.generate_docexports.data\n"
     )
-    _yaml.dump(data.docs_html_by_category("internal"), sys.stdout)
+    _yaml.dump(docs, sys.stdout)
 
 
 if __name__ == "__main__":