add Glossary and Security Advisory

Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@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: public
+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/apig-api-ref.yaml

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

otc_metadata/data/documents/apig-umn.yaml

@@ -1,6 +1,5 @@
 ---
 hc_location: usermanual/apig
-environment: internal
 html_location: docs/apig/umn
 link: /api-gateway/umn/
 pdf_name: apig-umn

otc_metadata/data/documents/apiu-guidelines.yaml

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: api-usage/guidelines
+html_location: docs/apiu/guidelines
+link: /api-usage/guidelines/
+pdf_name: apiu-guidelines
+rst_location: doc/guidelines/source
+service_type: apiu
+title: API Usage Guidelines
+type: guidelines

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/blueprints
+environment: internal
+html_location: docs/blueprints/best-practice
+link: /blueprints/best-practice/
+pdf_name: blueprints-best-practice
+rst_location: doc/best-practice/source
+service_type: blueprints
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,8 @@
+---
+html_location: docs/cc/api-ref
+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/cce-best-practice.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/cce
+environment: internal
+html_location: docs/cce/best-practice
+link: /cloud-container-engine/best-practice/
+pdf_name: cce-best-practice
+rst_location: doc/best-practice/source
+service_type: cce
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/css
+environment: internal
+html_location: docs/css/best-practice
+link: /cloud-search-service/best-practice/
+pdf_name: css-best-practice
+rst_location: doc/best-practice/source
+service_type: css
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/dc
+environment: internal
+html_location: docs/dc/best-practice
+link: /direct-connect/best-practice/
+pdf_name: dc-best-practice
+rst_location: doc/best-practice/source
+service_type: dc
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/dds
+environment: internal
+html_location: docs/dds/best-practice
+link: /document-database-service/best-practice/
+pdf_name: dds-best-practice
+rst_location: doc/best-practice/source
+service_type: dds
+title: Best Practice
+type: best-practice

otc_metadata/data/documents/dli-dev.yaml

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: devg/dli
+html_location: docs/dli/dev
+link: /data-lake-insight/dev-guide/
+pdf_name: dli-dev-guide
+rst_location: dev_guide/source
+service_type: dli
+title: Developer Guide
+type: dev

otc_metadata/data/documents/dli-sqlreference.yaml

@@ -0,0 +1,9 @@
+---
+hc_location: sqlreference/dli
+html_location: docs/dli/sqlreference
+link: /data-lake-insight/sqlreference/
+pdf_name: dli-sqlreference
+rst_location: doc/sqlreference/source
+service_type: dli
+title: Sql Syntax Reference
+type: sqlreference

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/dns
+environment: internal
+html_location: docs/dns/best-practice
+link: /domain-name-service/best-practice/
+pdf_name: dns-best-practice
+rst_location: doc/best-practice/source
+service_type: dns
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/drs
+environment: internal
+html_location: docs/drs/best-practice
+link: /data-replication-service/best-practice/
+pdf_name: drs-best-practice
+rst_location: doc/best-practice/source
+service_type: drs
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/elb
+environment: internal
+html_location: docs/elb/best-practice
+link: /elastic-load-balancing/best-practice/
+pdf_name: elb-best-practice
+rst_location: doc/best-practice/source
+service_type: elb
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/evs
+environment: internal
+html_location: docs/evs/best-practice
+link: /elastic-volume-service/best-practice/
+pdf_name: evs-best-practice
+rst_location: doc/best-practice/source
+service_type: evs
+title: Best Practice
+type: best-practice

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

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

otc_metadata/data/documents/gaussdb_nosql-umn.yaml

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

otc_metadata/data/documents/hss-umn.yaml

@@ -1,7 +1,6 @@
 ---
 hc_location: usermanual/hss2.0
 environment: internal
-hc_location: usermanual/nosql
 html_location: docs/hss/umn
 link: /host-security-service/umn/
 pdf_name: hss-umn

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/ims
+environment: internal
+html_location: docs/ims/best-practice
+link: /image-management-service/best-practice/
+pdf_name: ims-best-practice
+rst_location: doc/best-practice/source
+service_type: ims
+title: Best Practice
+type: best-practice

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

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/natgw
+environment: internal
+html_location: docs/natgw/best-practice
+link: /nat-gateway/best-practice/
+pdf_name: natgw-best-practice
+rst_location: doc/best-practice/source
+service_type: natgw
+title: Best Practice
+type: best-practice

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

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

otc_metadata/data/documents/ocr-umn.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: usermanual/ocr
+environment: internal
+html_location: docs/ocr/umn
+link: /optical-character-recognition/umn/
+pdf_name: ocr-umn
+rst_location: umn/source
+service_type: ocr
+title: User Guide
+type: 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/swr-best-practice.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/swr
+environment: internal
+html_location: docs/swr/best-practice
+link: /software-repository-container/best-practice/
+pdf_name: swr-best-practice
+rst_location: doc/best-practice/source
+service_type: swr
+title: Best Practice
+type: best-practice

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/documents/vpc-best-practice.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: bestpractice/vpc
+environment: internal
+html_location: docs/vpc/best-practice
+link: /virtual-private-cloud/best-practice/
+pdf_name: vpc-best-practice
+rst_location: doc/best-practice/source
+service_type: vpc
+title: Best Practice
+type: best-practice

otc_metadata/data/service_categories/database.yaml

@@ -1,3 +1,3 @@
 ---
 name: database
-title: Database
+title: Databases

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/apig.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/api-gateway
@@ -7,10 +7,12 @@ repositories:
 - environment: public
   repo: opentelekomcloud-docs/api-gateway
   type: github
-service_category: big_data
+service_category: application
 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

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/api-usage
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/api-usage
+  type: github
+service_category: other
+service_title: API Usage
+service_type: apiu
+service_uri: api-usage
+teams:
+- name: eco
+  permission: write

otc_metadata/data/services/blueprints.yaml

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

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/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/gloss.yaml

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

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/optical-character-recognition
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/optical-character-recognition
+  type: github
+service_category: big_data
+service_title: Optical Character Recognition
+service_type: ocr
+service_uri: optical-character-recognition
+teams:
+- name: docs-bigdata-ai-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: internal
 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: internal
+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/templates/doc_requirements.txt.j2

@@ -1,7 +1,15 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
+{% if target_environment == 'public' %}
+otcdocstheme<2.0.0 # Apache-2.0
+{% elif target_environment == 'internal' %}
 otcdocstheme # Apache-2.0
+{% else %}
+otcdocstheme # Apache-2.0
+{% endif %}
 # releasenotes
 reno>=3.1.0 # Apache-2.0
 
 otc-sphinx-directives>=0.1.0
+sphinx-minify>=0.0.1 # Apache-2.0
 git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+setuptools

otc_metadata/templates/tox.ini.j2

@@ -34,23 +34,28 @@ allowlist_externals =
   rm
   sphinx-build
 commands =
-  rm -rf doc/build/html doc/build/doctrees
-  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
+  rm -rf doc/build/html doc/build/html_temp doc/build/doctrees
+  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp
+  sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html 
 {%- for doc in docs %}
   {[testenv:{{ doc.type }}]commands}
   {[testenv:json-{{ doc.type }}]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}
@@ -66,16 +71,14 @@ allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }}
-{%- if doc.type == 'api-ref' %}
-  mkdir -p api-ref/build/html
-  cp -av doc/build/html/api-ref api-ref/build/html
-{%- elif doc.type == 'umn' %}
-  mkdir -p umn/build/html
-  cp -av doc/build/html/umn umn/build/html
-{%- elif doc.type == 'dev-guide' %}
+  sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }}
+  sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }}
+{%- if doc.type == 'dev-guide' %}
   mkdir -p dev_guide/build/html
   cp -av doc/build/html/dev-guide dev_guide/build/html
+{%- else %}
+  mkdir -p {{ doc.type }}/build/html
+  cp -av doc/build/html/{{ doc.type }} {{ doc.type }}/build/html
 {%- endif %}
 
 # Json version (for search)
@@ -90,15 +93,12 @@ commands =
   # Drop data useless for the search - wrap it also with sh/xargs due to bugs
   # in tox
   sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
-{%- if doc.type == 'api-ref' %}
-  mkdir -p api-ref/build/json
-  cp -av doc/build/json/api-ref api-ref/build/json
-{%- elif doc.type == 'umn' %}
-  mkdir -p umn/build/json
-  cp -av doc/build/json/umn umn/build/json
-{%- elif doc.type == 'dev-guide' %}
+{%- if doc.type == 'dev-guide' %}
   mkdir -p dev_guide/build/json
   cp -av doc/build/json/dev-guide dev_guide/build/json
+{%- else %}
+  mkdir -p {{ doc.type }}/build/json
+  cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
 {%- endif %}
 
 {% if doc.pdf_name -%}
@@ -122,6 +122,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")
 
@@ -237,6 +238,8 @@ def process_repositories(args, service):
                 doc["type"] = "dev-guide"
             context["docs"].append(doc)
 
+        context["target_environment"] = args.target_environment
+
         tox_ini_content = tox_ini_template.render(**context)
         tox_ini_path = pathlib.Path(copy_to, "tox.ini")
         doc_requirements_content = doc_requirements_template.render(**context)
@@ -257,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(
@@ -313,6 +326,7 @@ def main():
     parser.add_argument(
         "--target-environment",
         required=True,
+        choices=["internal", "public"],
         help="Environment to be used as a source",
     )
     parser.add_argument("--service-type", help="Service to update")
@@ -341,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",