adding dev guide for apig and fixing modelarts

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-committed-by: Boka, Ladislav <ladislav.boka@t-systems.com>

.gitignore

@@ -59,3 +59,6 @@ ChangeLog
 
 # Files created by releasenotes build
 releasenotes/build
+
+bindep.txt
+packages.txt

otc_metadata/data/documents/ac-blueprints.yaml

@@ -0,0 +1,8 @@
+---
+environment: public
+link: /architecture-center/blueprints/
+pdf_name: architecture-center-blueprints
+rst_location: doc/blueprints/source
+service_type: ac
+title: Blueprints
+type: blueprints

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

@@ -0,0 +1,8 @@
+---
+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

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

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: api/aom2
+html_location: docs/aom2/api-ref
+link: /application-operations-management-2/api-ref/
+pdf_name: aom2-api-ref
+rst_location: api-ref/source
+service_type: aom2
+title: API Reference
+type: api-ref

otc_metadata/data/documents/aom2-umn.yaml

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: usermanual/aom2
+html_location: docs/aom2/umn
+link: /application-operations-management-2/umn/
+pdf_name: aom2-umn
+rst_location: umn/source
+service_type: aom2
+title: User Guide
+type: umn

otc_metadata/data/documents/apig-dev.yaml

@@ -0,0 +1,9 @@
+---
+hc_location: devg/apig
+html_location: docs/apig/dev
+link: /api-gateway/dev-guide/
+pdf_name: apig-dev-guide
+rst_location: dev_guide/source
+service_type: apig
+title: Developer Guide
+type: dev

otc_metadata/data/documents/bd-umn.yaml

@@ -0,0 +1,6 @@
+---
+link: /business-dashboard/umn/
+rst_location: umn/source
+service_type: bd
+title: User Guide
+type: umn

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

@@ -0,0 +1,7 @@
+---
+link: /cloud-create/api-ref/
+pdf_name: cc-api-ref
+rst_location: api-ref/source
+service_type: cc
+title: API Reference
+type: api-ref

otc_metadata/data/documents/cc-umn.yaml

@@ -0,0 +1,8 @@
+---
+html_location: docs/cc/umn
+link: /cloud-create/umn/
+pdf_name: cc-umn
+rst_location: umn/source
+service_type: cc
+title: User Guide
+type: umn

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

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

otc_metadata/data/documents/cfw-umn.yaml

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: usermanual/cfw
+html_location: docs/cfw/umn
+link: /cloud-firewall/umn/
+pdf_name: cfw-umn
+rst_location: umn/source
+service_type: cfw
+title: User Guide
+type: umn

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

@@ -1,6 +1,5 @@
 ---
 hc_location: bestpractice/css
-environment: internal
 html_location: docs/css/best-practice
 link: /cloud-search-service/best-practice/
 pdf_name: css-best-practice

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

@@ -1,6 +1,6 @@
 ---
 hc_location: api/ddm
-environment: internal
+environment: public
 html_location: docs/ddm/api-ref
 link: /distributed-database-middleware/api-ref/
 pdf_name: ddm-api-ref

otc_metadata/data/documents/ddm-umn.yaml

@@ -1,6 +1,6 @@
 ---
 hc_location: usermanual/ddm
-environment: internal
+environment: public
 html_location: docs/ddm/umn
 link: /distributed-database-middleware/umn/
 pdf_name: ddm-umn

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

@@ -1,6 +1,5 @@
 ---
 hc_location: api/functiongraph
-environment: internal
 html_location: docs/fg/api-ref
 link: /function-graph/api-ref/
 pdf_name: fg-api-ref

otc_metadata/data/documents/fg-umn.yaml

@@ -1,6 +1,5 @@
 ---
 hc_location: usermanual/functiongraph
-environment: internal
 html_location: docs/fg/umn
 link: /function-graph/umn/
 pdf_name: fg-umn

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

@@ -1,5 +1,5 @@
 ---
-hc_location: api/ma
+hc_location: api/modelarts
 html_location: docs/modelarts/api-ref
 link: /modelarts/api-ref/
 pdf_name: ma-api-ref

otc_metadata/data/documents/ma-sdk-ref.yaml

@@ -1,5 +1,5 @@
 ---
-hc_location: sdk/ma
+hc_location: sdk/modelarts
 html_location: docs/modelarts/sdk-ref
 link: /modelarts/sdk-ref/
 pdf_name: ma-sdk-ref

otc_metadata/data/documents/ma-umn.yaml

@@ -1,5 +1,5 @@
 ---
-hc_location: usermanual/ma
+hc_location: usermanual/modelarts
 html_location: docs/modelarts/umn
 link: /modelarts/umn/
 pdf_name: ma-umn

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

@@ -1,6 +1,5 @@
 ---
 hc_location: api/ocr
-environment: internal
 html_location: docs/ocr/api-ref
 link: /optical-character-recognition/api-ref/
 pdf_name: ocr-api-ref

otc_metadata/data/documents/ocr-umn.yaml

@@ -1,6 +1,5 @@
 ---
 hc_location: usermanual/ocr
-environment: internal
 html_location: docs/ocr/umn
 link: /optical-character-recognition/umn/
 pdf_name: ocr-umn

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

@@ -1,9 +0,0 @@
----
-hc_location: api/rts
-html_location: docs/rts/api-ref
-link: /resource-template-service/api-ref/
-pdf_name: rts-api-ref
-rst_location: api-ref/source
-service_type: rts
-title: API Reference
-type: api-ref

otc_metadata/data/documents/rts-umn.yaml

@@ -1,9 +0,0 @@
----
-hc_location: usermanual/rts
-html_location: docs/rts/umn
-link: /resource-template-service/umn/
-pdf_name: rts-umn
-rst_location: umn/source
-service_type: rts
-title: User Guide
-type: umn

otc_metadata/data/documents/sd-umn.yaml

@@ -1,9 +0,0 @@
----
-hc_location: usermanual/sd
-html_location: docs/sd/umn
-link: /status-dashboard/umn/
-pdf_name: sd-umn
-rst_location: umn/source
-service_type: sd
-title: User Guide
-type: umn

otc_metadata/data/documents/tcc-umn.yaml

@@ -1,8 +0,0 @@
----
-html_location: docs/tcc/umn
-link: /telekom-cloud-create/umn/
-pdf_name: tcc-umn
-rst_location: umn/source
-service_type: tcc
-title: User Guide
-type: umn

otc_metadata/data/services/ac.yaml

@@ -0,0 +1,16 @@
+---
+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

otc_metadata/data/services/aom2.yaml

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/application-operations-management-2
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/application-operations-management-2
+  type: github
+service_category: application
+service_title: Application Operations Management 2.0
+service_type: aom2
+service_uri: application-operations-management-2
+teams:
+- name: docs-orchestration-rw
+  permission: write

otc_metadata/data/services/apig.yaml

@@ -12,7 +12,5 @@ service_title: API Gateway (APIG)
 service_type: apig
 service_uri: api-gateway
 teams:
-- name: docs-bigdata-ai-rw
-  permission: write
 - name: docs-orchestration-rw
   permission: write

otc_metadata/data/services/apiu.yaml

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

otc_metadata/data/services/bd.yaml

@@ -0,0 +1,13 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/business-dashboard
+  type: gitea
+service_category: other
+service_title: Business Dashboard
+service_type: bd
+service_uri: business-dashboard
+teams:
+- name: docs-dashboard-rw
+  permission: write

otc_metadata/data/services/cc.yaml

@@ -0,0 +1,13 @@
+---
+environment: public
+repositories:
+- environment: public
+  repo: opentelekomcloud-docs/cloud-create
+  type: github
+service_category: md
+service_title: Cloud Create 
+service_type: cc
+service_uri: cloud-create
+teams:
+- name: topology-designer-rw
+  permission: write

otc_metadata/data/services/cfw.yaml

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/cloud-firewall
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/cloud-firewall
+  type: github
+service_category: security-services
+service_title: Cloud Firewall
+service_type: cfw
+service_uri: cloud-firewall
+teams:
+- name: docs-security-services-rw
+  permission: write

otc_metadata/data/services/ddm.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/distributed-database-middleware

otc_metadata/data/services/dod.yaml

@@ -0,0 +1,13 @@
+---
+environment: hidden
+repositories:
+- environment: public
+  repo: opentelekomcloud-docs/docs_on_docs
+  type: github
+service_category: other
+service_title: Documentation about documentation
+service_type: dod
+service_uri: docs-on-docs
+teams:
+- name: docs-eco-rw
+  permission: write

otc_metadata/data/services/fg.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/function-graph
@@ -12,5 +12,5 @@ service_title: FunctionGraph
 service_type: fg
 service_uri: function-graph
 teams:
-- name: docs-compute-rw
+- name: docs-orchestration-rw
   permission: write

otc_metadata/data/services/gloss.yaml

@@ -0,0 +1,16 @@
+---
+environment: hidden
+repositories:
+- environment: internal
+  repo: docs/glossary
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/glossary
+  type: github
+service_category: other
+service_title: Glossary
+service_type: gloss
+service_uri: glossary
+teams:
+- name: docs-eco-rw
+  permission: write

otc_metadata/data/services/intdocs.yaml

@@ -0,0 +1,13 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/internal-documentation
+  type: gitea
+service_category: other
+service_title: Internal Documentation
+service_type: intdocs
+service_uri: internal-documentation
+teams:
+- name: docs-eco-rw
+  permission: write

otc_metadata/data/services/ocr.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/optical-character-recognition

otc_metadata/data/services/rae.yaml

@@ -0,0 +1,16 @@
+---
+environment: hidden
+repositories:
+- environment: internal
+  repo: docs/regions-and-endpoints
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/regions-and-endpoints
+  type: github
+service_category: other
+service_title: Regions and Endpoints
+service_type: rae
+service_uri: regions-and-endpoints
+teams:
+- name: docs-eco-rw
+  permission: write

otc_metadata/data/services/rts.yaml

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

otc_metadata/data/services/sd.yaml

@@ -1,5 +1,5 @@
 ---
-environment: hidden
+environment: public
 repositories:
 - environment: internal
   repo: docs/status-dashboard
@@ -10,7 +10,7 @@ repositories:
 service_category: other
 service_title: Status Dashboard
 service_type: sd
-service_uri: status-dashboard/umn
+service_uri: status-dashboard
 teams:
 - name: docs-eco-rw
   permission: write

otc_metadata/data/services/sec.yaml

@@ -0,0 +1,16 @@
+---
+environment: hidden
+repositories:
+- environment: internal
+  repo: docs/security
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/security
+  type: github
+service_category: other
+service_title: Security
+service_type: sec
+service_uri: security
+teams:
+- name: docs-eco-rw
+  permission: write

otc_metadata/data/services/tcc.yaml

@@ -1,13 +0,0 @@
----
-environment: hidden
-repositories:
-- environment: public
-  repo: opentelekomcloud-docs/telekom-cloud-create
-  type: github
-service_category: other
-service_title: Telekom Cloud Create 
-service_type: tcc
-service_uri: telekom-cloud-create
-teams:
-- name: topology-designer-rw
-  permission: write

otc_metadata/services.py

@@ -246,12 +246,19 @@ class Services(object):
                     x for x in srv["teams"] if x["permission"] == "write"
                 ]
             if "repositories" in srv and environment:
+                internal_exists = False
                 for repo in srv["repositories"]:
                     if (
                         "environment" in repo
                         and repo["environment"] == environment
                     ):
                         srv_res["repository"] = repo["repo"]
+                        if repo["environment"] == "internal":
+                            internal_exists = True
+                # internal repo does not exist
+                # service will be left out from metadata.yaml
+                if not internal_exists:
+                    continue
             for doc in self.all_docs:
                 if (
                     "html_location" in doc

otc_metadata/templates/conf.py.j2

@@ -38,14 +38,14 @@ otcdocs_git_type = '{{ git_type }}'
 {%- endif %}
 
 # Those variables are needed for indexing into OpenSearch
-otcdocs_doc_environment = "{{ doc_environment }}"
+otcdocs_doc_environment = '{{ doc_environment }}'
-otcdocs_doc_link = "{{ doc_link }}"
+otcdocs_doc_link = '{{ doc_link }}'
-otcdocs_doc_title = "{{ doc_title }}"
+otcdocs_doc_title = '{{ doc_title }}'
-otcdocs_doc_type = "{{ doc_type }}"
+otcdocs_doc_type = '{{ doc_type }}'
-otcdocs_service_category = "{{ service_category }}"
+otcdocs_service_category = '{{ service_category }}'
-otcdocs_service_title = "{{ service_title }}"
+otcdocs_service_title = '{{ service_title }}'
-otcdocs_service_type = "{{ service_type }}"
+otcdocs_service_type = '{{ service_type }}'
-otcdocs_search_environment = "hc_de"
+otcdocs_search_environment = 'hc_de'
 otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
 
 # If extensions (or modules to document with autodoc) are in another directory,

otc_metadata/templates/doc_requirements.txt.j2

@@ -1,6 +1,6 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
 {% if target_environment == 'public' %}
-otcdocstheme<1.0.0 # Apache-2.0
+otcdocstheme<2.0.0 # Apache-2.0
 {% elif target_environment == 'internal' %}
 otcdocstheme # Apache-2.0
 {% else %}
@@ -11,4 +11,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
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+setuptools

otc_metadata/templates/tox.ini.j2

@@ -13,6 +13,8 @@ commands = stestr run {posargs}
   stestr slowest
 
 [testenv:pep8]
+allowlist_externals =
+  doc8
 commands =
   doc8 doc/source README.rst
 
@@ -43,15 +45,19 @@ commands =
 {%- endfor %}
 
 [testenv:docs-pdf]
-deps = {[testenv:docs]deps}
+deps =
+  {[testenv:docs]deps}
+  {[testenv:bindeps]deps}
 allowlist_externals =
   rm
   mkdir
+  wget
   make
   bash
   cp
 commands =
   mkdir -p doc/build/pdf
+  {[testenv:bindeps]commands}
 {%- for doc in docs %}
 {%- if doc.pdf_name %}
   {[testenv:{{ doc.type }}-pdf-docs]commands}
@@ -118,6 +124,21 @@ commands =
 {% endif %}
 {% endfor %}
 
+[testenv:bindeps]
+deps =
+    bindep
+allowlist_externals =
+    wget
+    rm
+    bash
+commands =
+    rm -rf {toxinidir}/bindep.txt
+    rm -rf {toxinidir}/packages.txt
+    wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
+    bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
+    bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
+    bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
+
 [doc8]
 ignore = D001
 extensions = .rst, .yaml

otc_metadata/templates/zuul.yaml.j2

@@ -0,0 +1,12 @@
+---
+- project:
+    merge-mode: squash-merge
+    default-branch: main
+    templates:
+      - helpcenter-base-jobs
+    check:
+      jobs:
+        - noop
+    gate:
+      jobs:
+        - noop

tools/generate_doc_confpy.py

@@ -50,6 +50,7 @@ def process_repositories(args, service):
     )
     conf_py_template = env.get_template("conf.py.j2")
     tox_ini_template = env.get_template("tox.ini.j2")
+    zuul_yaml_template = env.get_template("zuul.yaml.j2")
     index_sbv_template = env.get_template("index_sbv.rst.j2")
     doc_requirements_template = env.get_template("doc_requirements.txt.j2")
 
@@ -259,6 +260,16 @@ def process_repositories(args, service):
             out.write(doc_requirements_content)
         repo_to.index.add(["doc/requirements.txt"])
 
+    if args.update_zuul:
+        """Update zuul.yaml"""
+
+        zuul_yaml_content = zuul_yaml_template.render(**context)
+        zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")
+        with open(zuul_yaml_path, "w", encoding="utf-8", newline="") as out:
+            logging.debug(f"Generating {zuul_yaml_path} from template...")
+            out.write(zuul_yaml_content)
+        repo_to.index.add(["zuul.yaml"])
+
     if len(repo_to.index.diff("HEAD")) == 0:
         # Nothing to commit
         logging.debug(
@@ -344,6 +355,11 @@ def main():
         action="store_true",
         help="Whether to update service-based-view"
     )
+    parser.add_argument(
+        "--update-zuul",
+        action="store_true",
+        help="Whether to update zuul.yaml"
+    )
     parser.add_argument(
         "--overwrite-index-sbv",
         action="store_true",

tools/sync_doc_repo.py

@@ -95,12 +95,12 @@ def process_repositories(args, service):
                 f"due to the doc-type filter."
             )
             continue
-        if doc.get("environment"):
+        # if doc.get("environment"):
-            logging.info(
+        #     logging.info(
-                f"Skipping synchronizing {doc['title']} "
+        #         f"Skipping synchronizing {doc['title']} "
-                f"since it is environment bound."
+        #         f"since it is environment bound."
-            )
+        #     )
-            continue
+        #     continue
 
         branch_name = f"{args.branch_name}#{doc['type']}"
         remote_ref = SymbolicReference.create(