feat: split metadata into smal pieces

.gitignore

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

otc_metadata/data/documents/as-dev.yaml

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

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

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

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

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

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

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

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

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

@@ -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/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/big_data.yaml

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

otc_metadata/data/service_categories/database.yaml

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

otc_metadata/data/services/sd.yaml

@@ -1,16 +0,0 @@
----
-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,15 +48,6 @@ 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)
@@ -122,58 +113,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
 
@@ -237,8 +176,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:
@@ -262,7 +199,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

@@ -37,18 +37,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,14 +1,7 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
-{% if target_environment == 'public' %}
-otcdocstheme<1.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

tools/generate_doc_confpy.py

@@ -148,30 +148,8 @@ def process_repositories(args, service):
             context["html_options"] = dict(
                 disable_search=True,
                 site_name="Internal Documentation Portal",
-                logo_url="https://docs-int.sc.otc.t-systems.com",
+                logo_url="https://docs-int.otc-service.com",
             )
-        else:
-            context["html_options"] = dict(
-                site_name="Swiss Open Telekom Cloud Docs",
-                logo_url="https://docs-beta.sc.otc.t-systems.com",
-            )
-        context["doc_environment"] = args.target_environment
-        if doc['link']:
-            context["doc_link"] = doc['link']
-        else:
-            context["doc_link"] = (
-                '/'
-                + service['service_uri']
-                + '/'
-                + doc['type']
-                + '/'
-            )
-        context["doc_title"] = doc['title']
-        context["doc_type"] = doc['type']
-        context["service_category"] = service['service_category']
-        context["service_title"] = service['service_title']
-        context["service_type"] = service['service_type']
-
         conf_py_content = conf_py_template.render(**context)
         with open(conf_py_path, "w", encoding="utf-8", newline="") as out:
             logging.debug(f"Generating {conf_py_path} from template...")
@@ -189,8 +167,6 @@ def process_repositories(args, service):
             title=f"{service['service_title']} - Service Based View",
             service_type=service["service_type"]
         )
-        context["service_category"] = service['service_category']
-        context["service_title"] = service['service_title']
         if not copy_path.exists():
             logging.info("Path for sbv does not exist")
             copy_path.mkdir(parents=True, exist_ok=True)
@@ -203,12 +179,7 @@ def process_repositories(args, service):
             context["html_options"] = dict(
                 disable_search=True,
                 site_name="Internal Documentation Portal",
-                logo_url="https://docs-int.sc.otc.t-systems.com",
+                logo_url="https://docs-int.otc-service.com",
-            )
-        else:
-            context["html_options"] = dict(
-                site_name="Swiss Open Telekom Cloud Docs",
-                logo_url="https://docs-beta.sc.otc.t-systems.com",
             )
         sbv_title = (service["service_title"] + "\n"
                      + ('=' * len(service["service_title"])))
@@ -247,8 +218,6 @@ 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)
@@ -279,7 +248,7 @@ def process_repositories(args, service):
         args.commit_description
     )
     push_args = ["--set-upstream", "origin", branch_name]
-    if args.force_push:
+    if args.branch_force:
         push_args.append("--force")
     repo_to.git.push(*push_args)
     if "github" in url_to:
@@ -325,7 +294,6 @@ 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")
@@ -360,11 +328,6 @@ def main():
         help=("Whether to overwrite index.rst for service-based-view."
               + "\nCan only be used if --update-sbv is also specified")
     )
-    parser.add_argument(
-        "--force-push",
-        action="store_true",
-        help="Whether to force push the commit"
-    )
     parser.add_argument(
         "--commit-description",
         default=(

tools/generate_doc_gitcontrol_repos.py

@@ -32,11 +32,9 @@ 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,7 +10,6 @@ import otc_metadata.services
 
 def main():
     data = otc_metadata.services.Services()
-    data._sort_data()
 
     _yaml = YAML()
     _yaml.indent(mapping=2, sequence=4, offset=2)