adding constraints reference

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>

otc_metadata/data/documents/as-dev.yaml

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

otc_metadata/data/documents/ecs-dev.yaml

@@ -1,9 +0,0 @@
----
-hc_location: devg/ecs
-html_location: docs/ecs/dev
-link: /elastic-cloud-server/dev-guide/
-pdf_name: ecs-dev-guide
-rst_location: dev_guide/source
-service_type: ecs
-title: Developer Guide
-type: dev

otc_metadata/data/documents/evs-dev.yaml

@@ -1,9 +0,0 @@
----
-hc_location: devg/evs
-html_location: docs/evs/dev
-link: /elastic-volume-service/dev-guide/
-pdf_name: evs-dev-guide
-rst_location: dev_guide/source
-service_type: evs
-title: Developer Guide
-type: dev

otc_metadata/data/documents/iam-permissions.yaml

@@ -0,0 +1,8 @@
+---
+html_location: docs/iam/permissions
+link: /identity-access-management/permissions/
+pdf_name: iam-permissions
+rst_location: doc/permissions/source
+service_type: iam
+title: Permissions
+type: permissions

otc_metadata/data/documents/ims-dev.yaml

@@ -1,9 +0,0 @@
----
-hc_location: devg/ims
-html_location: docs/ims/dev
-link: /image-management-service/dev-guide/
-pdf_name: ims-dev-guide
-rst_location: dev_guide/source
-service_type: ims
-title: Developer Guide
-type: dev

otc_metadata/data/documents/ims-public-images.yaml

@@ -1,8 +0,0 @@
----
-html_location: docs/ims/public-images
-link: /image-management-service/public-images/
-pdf_name: ims-public-images
-rst_location: doc/public-images/source
-service_type: ims
-title: Public Image Introduction
-type: public-images

otc_metadata/data/documents/obs-parallel-file-system.yaml

@@ -1,9 +0,0 @@
----
-hc_location: pfs/obs
-html_location: docs/obs/pfs
-link: /object-storage-service/parallel-file-system/
-pdf_name: obs-pfs
-rst_location: doc/parallel-file-system/source
-service_type: obs
-title: Parallel File System (PFS)
-type: parallel-file-system

otc_metadata/data/documents/obs-permissions-configuration-guide.yaml

@@ -1,8 +0,0 @@
----
-html_location: docs/obs/perms-cfg
-link: /object-storage-service/permissions-configuration-guide/
-pdf_name: obs-perms-cfg
-rst_location: doc/permissions-configuration-guide/source
-service_type: obs
-title: Permissions Configuration Guide
-type: permissions-configuration-guide

otc_metadata/data/documents/obs-swiftapi.yaml

@@ -1,9 +0,0 @@
----
-hc_location: api_swift/obs
-html_location: docs/obs/api-swift
-link: /object-storage-service/swiftapi/
-pdf_name: obs-swiftapi
-rst_location: doc/swiftapi/source
-service_type: obs
-title: API Reference (Swift)
-type: swiftapi

otc_metadata/data/documents/sd-umn.yaml

@@ -0,0 +1,9 @@
+---
+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/service_categories/big_data.yaml

@@ -1,3 +0,0 @@
----
-name: big_data
-title: Big Data and Data Analysis

otc_metadata/data/services/sd.yaml

@@ -0,0 +1,16 @@
+---
+repositories:
+- environment: internal
+  repo: docs-swiss/status-dashboard
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs-swiss/status-dashboard
+  type: github
+service_category: other
+service_title: Status Dashboard
+service_type: sd
+service_uri: status-dashboard/umn
+environment: hidden
+teams:
+- name: docs-eco-rw
+  permission: write

otc_metadata/services.py

@@ -48,6 +48,15 @@ class Services(object):
             self._service_data["services"],
             key=lambda x: f"{x.get('service_type')}{x.get('service_title')}",
         )
+        # sort service categories by <name>_<title>
+        self._service_data["service_categories"] = sorted(
+            self._service_data["service_categories"],
+            key=lambda x: f"{x.get('name')}{x.get('title')}",
+        )
+        other = {'name': 'other', 'title': 'Other'}
+        if other in self._service_data["service_categories"]:
+            self._service_data["service_categories"].remove(other)
+            self._service_data["service_categories"].append(other)
 
     def _rewrite_data(self):
         otc_metadata.data.rewrite_data("services.yaml", self._service_data)

otc_metadata/templates/conf.py.j2

@@ -26,6 +26,7 @@ extensions = [
 
 otcdocs_auto_name = False
 otcdocs_auto_version = False
+otcdocs_search_environment = 'hc_swiss'
 
 project = '{{ project }}'
 otcdocs_repo_name = '{{ repo_name }}'

otc_metadata/templates/tox.ini.j2

@@ -24,7 +24,9 @@ commands = {posargs}
 # This env is invoked in the periodic pipeline and is therefore responsible to
 # build all relevant docs at once.
 [testenv:docs]
-deps = -r{toxinidir}/doc/requirements.txt
+deps =
+  -r{toxinidir}/doc/requirements.txt
+  -c https://raw.githubusercontent.com/opentelekomcloud-docs-swiss/docs-constraints/main/constraints.txt
 allowlist_externals =
   mkdir
   cp
@@ -40,7 +42,7 @@ commands =
 {%- endfor %}
 
 [testenv:docs-pdf]
-deps = -r{toxinidir}/doc/requirements.txt
+deps = {[testenv:docs]deps}
 allowlist_externals =
   rm
   mkdir
@@ -59,7 +61,7 @@ commands =
 {% set loc = doc.rst_location | replace('/source', '') %}
 # HTML version
 [testenv:{{ doc.type }}]
-deps = -r{toxinidir}/doc/requirements.txt
+deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
@@ -78,7 +80,7 @@ commands =
 
 # Json version (for search)
 [testenv:json-{{ doc.type }}]
-deps = -r{toxinidir}/doc/requirements.txt
+deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
@@ -102,7 +104,7 @@ commands =
 {% if doc.pdf_name -%}
 # PDF version
 [testenv:{{ doc.type }}-pdf-docs]
-deps = -r{toxinidir}/doc/requirements.txt
+deps = {[testenv:docs]deps}
 allowlist_externals =
   rm
   mkdir

tools/generate_doc_gitcontrol_repos.py

@@ -32,9 +32,11 @@ def process_services(args, services):
         block_on_rejected_reviews=True,
         dismiss_stale_approvals=True,
         enable_push=False,
+        enable_status_check=True,
         status_check_contexts=["gl/check"],
         enable_merge_whitelist=True,
         merge_whitelist_usernames=["zuul"],
+        required_approvals=1,
     )
     gitea_repo_template = dict(
         default_branch="main",

tools/generate_docexports_data.py

@@ -10,6 +10,7 @@ import otc_metadata.services
 
 def main():
     data = otc_metadata.services.Services()
+    data._sort_data()
 
     _yaml = YAML()
     _yaml.indent(mapping=2, sequence=4, offset=2)