adding constraints reference

.gitignore

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

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

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

otc_metadata/data/documents/lts-umn.yaml

@@ -1,10 +0,0 @@
----
-environment: internal
-hc_location: usermanual/lts
-html_location: docs/lts/umn
-link: /log-tank-service/umn/
-pdf_name: lts-umn
-rst_location: umn/source
-service_type: lts
-title: User Guide
-type: umn

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

@@ -1,4 +1,5 @@
 ---
+environment: internal
 hc_location: api/dwaf
 html_location: docs/wafd/api-ref
 link: /web-application-firewall-dedicated/api-ref/

otc_metadata/data/documents/wafd-umn.yaml

@@ -1,4 +1,5 @@
 ---
+environment: internal
 hc_location: usermanual/dwaf
 html_location: docs/wafd/umn
 link: /web-application-firewall-dedicated/umn/

otc_metadata/data/service_categories/database.yaml

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

otc_metadata/data/services/lts.yaml

@@ -1,16 +0,0 @@
----
-environment: internal
-repositories:
-- environment: internal
-  repo: docs-swiss/log-tank-service
-  type: gitea
-- environment: public
-  repo: opentelekomcloud-docs-swiss/log-tank-service
-  type: github
-service_category: md
-service_title: Log Tank Service
-service_type: lts
-service_uri: log-tank-service
-teams:
-- name: docs-orchestration-rw
-  permission: write

otc_metadata/services.py

@@ -87,13 +87,10 @@ class Services(object):
             res.append(copy.deepcopy(cat))
         return res
 
-    def services_by_category(self, category, environment=None):
+    def services_by_category(self, category):
         """List services matching category"""
         res = []
         for srv in self.all_services:
-            if environment:
-                if "environment" in srv and srv["environment"] != environment:
-                    continue
             if srv["service_category"] == category:
                 res.append(copy.deepcopy(srv))
         return res
@@ -125,58 +122,6 @@ class Services(object):
             res[cat]["docs"].append(res_doc)
         return res
 
-    def service_types_with_doc_types(self, environment=None):
-        """Retrieve type and title from services and corresponding docs.
-            As well as a list of all available doc types with title.
-
-        :param str environment: Optional service environment.
-        """
-        service_list = []
-        docs = []
-
-        for service in self.all_services:
-            if "environment" in service:
-                if service["environment"] != environment:
-                    continue
-            if not service["service_title"]:
-                continue
-            if not service["service_type"]:
-                continue
-
-            doc_list = []
-            for doc in self.all_docs:
-                if "environment" in doc:
-                    if doc["environment"] != environment:
-                        continue
-                if doc["service_type"] == service["service_type"]:
-                    doc_list.append({
-                        "title": doc["title"],
-                        "type": doc["type"]
-                    })
-
-                new_doc = {
-                    "type": doc["type"],
-                    "title": doc["title"]
-                }
-                type_exists = any(
-                    doc_dict["type"] == new_doc["type"] for doc_dict in docs
-                )
-                if not type_exists:
-                    docs.append(new_doc)
-
-            service_list.append({
-                "service_title": service["service_title"],
-                "service_type": service["service_type"],
-                "docs": doc_list
-            })
-
-        res = {
-            "services": service_list,
-            "docs": docs
-        }
-
-        return res
-
     def docs_by_service_category(self, category, environment=None):
         """List services matching category
 
@@ -240,8 +185,6 @@ class Services(object):
             srv_res = dict(
                 service_title=srv["service_title"],
                 service_type=srv["service_type"],
-                service_category=srv["service_category"],
-                service_environment=environment,
                 docs=[],
             )
             if "teams" in srv:
@@ -265,7 +208,6 @@ class Services(object):
                         rst_location=doc["rst_location"],
                         title=doc["title"],
                         type=doc.get("type", "dummy"),
-                        link=doc["link"],
                     )
                     if "pdf_name" in doc:
                         doc_res["pdf_name"] = doc["pdf_name"]

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 }}'
@@ -37,18 +38,6 @@ otcdocs_git_fqdn = '{{ git_fqdn }}'
 otcdocs_git_type = '{{ git_type }}'
 {%- endif %}
 
-# Those variables are needed for indexing into OpenSearch
-otcdocs_doc_environment = '{{ doc_environment }}'
-otcdocs_doc_link = '{{ doc_link }}'
-otcdocs_doc_title = '{{ doc_title }}'
-otcdocs_doc_type = '{{ doc_type }}'
-otcdocs_service_category = '{{ service_category }}'
-otcdocs_service_title = '{{ service_title }}'
-otcdocs_service_type = '{{ service_type }}'
-otcdocs_search_environment = 'hc_swiss'
-otcdocs_search_index = 'search_index_swiss'
-otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

otc_metadata/templates/doc_requirements.txt.j2

@@ -1,15 +1,7 @@
 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-swiss.git#egg=otc_metadata
-setuptools

otc_metadata/templates/index_sbv.rst.j2

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

otc_metadata/templates/tox.ini.j2

@@ -34,28 +34,23 @@ allowlist_externals =
   rm
   sphinx-build
 commands =
-  rm -rf doc/build/html doc/build/html_temp doc/build/doctrees
+  rm -rf doc/build/html doc/build/doctrees
-  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp
+  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
-  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 =
+deps = {[testenv:docs]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}
@@ -71,14 +66,16 @@ allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }}
+  sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }}
-  sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }}
+{%- if doc.type == 'api-ref' %}
-{%- if doc.type == 'dev-guide' %}
+  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' %}
   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)
@@ -93,12 +90,15 @@ 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 == 'dev-guide' %}
+{%- 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' %}
   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,21 +122,6 @@ 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

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