10 Commits

Author SHA1 Message Date
a26c0b8c11 fix pep8
All checks were successful
gl/check check status: success (a26c0b8c11ee4d894b162f2e4cb7e444458823a2)
gl/gate gate status: success (a26c0b8c11ee4d894b162f2e4cb7e444458823a2)
2025-05-14 07:20:23 +00:00
75bf927aa7 fix glossary
Some checks failed
gl/check check status: failure (75bf927aa7e95e443822901456401eae1db3d6f1)
2025-05-12 10:22:42 +00:00
4079591fa9 fix glossary 2025-05-12 10:22:29 +00:00
59a17c599a Docs constraints new architecture 2025-05-09 12:30:45 +00:00
a41f77df9a Fix issue 2025-05-05 13:02:49 +00:00
c2a89cf6b1 Fix update_zuul 2025-04-30 12:22:17 +00:00
bf825ffdaa remove testservice 2025-04-30 09:18:33 +00:00
6960b72f63 Fix aom-api-ref 2025-04-30 09:17:42 +00:00
d7868e7d72 fix taurusdb 2025-04-30 09:14:50 +00:00
28e651dffb test 2025-04-30 09:13:18 +00:00
11 changed files with 24 additions and 77 deletions

View File

@ -1,11 +1,11 @@
---
hc_location: usermanual/aom
html_location: docs/aom/umn
link: /application-operations-management/umn/
rst_location: umn/source
hc_location: api/aom
html_location: docs/aom/api-ref
link: /application-operations-management/api-ref/
rst_location: api-ref/source
service_type: aom
title: User Guide
type: umn
title: API Reference
type: api-ref
cloud_environments:
- name: eu_de
visibility: public

View File

@ -2,6 +2,7 @@
hc_location: usermanual/taurusdb
html_location: docs/taurusdb/umn
link: /taurusdb/umn/
rst_location: umn/source
pdf_enabled: true
service_type: taurusdb
title: User Guide

View File

@ -1,13 +0,0 @@
---
hc_location: usermanual/testservice
html_location: docs/testservice/api-ref
link: /testservice/api-ref/
rst_location: api-ref/source
service_type: testservice
title: User Guide
type: api-ref
cloud_environments:
- name: swiss
visibility: public
pdf_visibility: public
pdf_enabled: true

View File

@ -1,13 +0,0 @@
---
hc_location: usermanual/testservice
html_location: docs/testservice/umn
link: /testservice/umn/
rst_location: umn/source
service_type: testservice
title: User Guide
type: umn
cloud_environments:
- name: eu_de
visibility: public
pdf_visibility: public
pdf_enabled: true

View File

@ -5,9 +5,9 @@ repositories:
repo: opentelekomcloud-docs/glossary
type: github
cloud_environments:
-
- eu_de
- environment: internal
repo: docs/glossary
type: gitea
cloud_environments:
-
- eu_de

View File

@ -1,13 +0,0 @@
---
service_type: testservice
repositories:
- environment: public
repo: opentelekomcloud-docs/testservice
type: github
cloud_environments:
- eu_de
- environment: internal
repo: docs/testservice
type: gitea
cloud_environments:
- eu_de

View File

@ -1,14 +0,0 @@
---
environment: public
is_global: false
service_category: security-services
service_title: Test Service
service_type: testservice
service_uri: testservice
cloud_environments:
- name: eu_de
visibility: internal
teams:
- name: docs-security-services-rw
permission: write
is_global: false

View File

@ -13,7 +13,6 @@
import copy
import warnings
import json
import otc_metadata.data
@ -76,7 +75,7 @@ class Services(object):
def all_docs(self):
"Service Docs data listing."
return copy.deepcopy(self._service_data["documents"])
@property
def all_repositories(self):
"Service Repositories data listing."
@ -151,7 +150,7 @@ class Services(object):
continue
for repositories in self.all_repositories:
if repositories["service_type"] == service["service_type"]:
res["repositories"] = repositories["repositories"]
res[cat]["repositories"] = repositories["repositories"]
res[cat].setdefault("docs", [])
res[cat]["docs"].append(res_doc)
return res
@ -283,7 +282,7 @@ class Services(object):
if not service:
warnings.warn("No Service defition of type %s" % (cat))
continue
for repositories in self.all_repositories:
if repositories["service_type"] == service["service_type"]:
res_doc = copy.deepcopy(doc)
@ -386,7 +385,7 @@ class Services(object):
break
break
return res
def get_service_with_repo_by_service_type(self, service_type):
"""Retrieve service with repos by service_type
@ -417,7 +416,7 @@ class Services(object):
res[i]["repositories"] = repositories["repositories"]
break
return res
def all_services_by_categories(self, cloud_environment, environments):
"""Retrieve all services sorted by categories
"""
@ -440,7 +439,7 @@ class Services(object):
for i, category in enumerate(res):
if category["name"] == srv["service_category"]:
res[i]["services"].append(srv)
# Sort services
for category in res:
category["services"].sort(key=lambda x: x.get("service_title", "").lower())
@ -448,4 +447,4 @@ class Services(object):
# Sort categories
res.sort(key=lambda x: x.get("name", "").lower())
return res
return res

View File

@ -28,7 +28,7 @@ commands = {posargs}
[testenv:docs]
deps =
-r{toxinidir}/doc/requirements.txt
-c https://raw.githubusercontent.com/opentelekomcloud-docs/docs-constraints/main/constraints.txt
-c https://raw.githubusercontent.com/opentelekomcloud-docs/docs-constraints/main/constraints/{{otcdocs_cloud_environment}}/{{target_environment}}/constraints.txt
allowlist_externals =
mkdir
cp

View File

@ -170,7 +170,7 @@ def process_repositories(args, service):
if target_repo.get("type") != "github":
context["git_type"] = target_repo["type"]
if (args.target_environment == "public"
and args.cloud_environment == "swiss"):
and args.cloud_environment == "swiss"):
context["html_options"] = dict(
logo_url="https://docs.sc.otc.t-systems.com",
)
@ -183,7 +183,7 @@ def process_repositories(args, service):
context["otcdocs_search_environment"] = "hc_de"
context["otcdocs_search_index"] = "search_index_de"
elif (args.target_environment == "internal"
and args.cloud_environment == "swiss"):
and args.cloud_environment == "swiss"):
context["html_options"] = dict(
disable_search=True,
site_name="Internal Documentation Portal",
@ -348,11 +348,11 @@ def process_repositories(args, service):
if cloud_environment["name"] == args.cloud_environment:
if doc["type"] == "dev":
doc["type"] = "dev-guide"
if cloud_environment["name"] == "swiss":
context["template"] = "helpcenter-swiss-base-jobs"
elif cloud_environment["name"] == "eu_de":
context["template"] = "helpcenter-base-jobs"
context["docs"].append(doc)
if args.cloud_environment == "swiss":
context["template"] = "helpcenter-swiss-base-jobs"
elif args.cloud_environment == "eu_de":
context["template"] = "helpcenter-base-jobs"
context["service_type"] = service['service_type']
zuul_yaml_content = zuul_yaml_template.render(**context)

View File

@ -24,7 +24,7 @@ def main():
data = otc_metadata.services.Services()
data._sort_data()
docs = data.docs_html_by_category(environment="internal",cloud_environment=args.cloud_environment)
docs = data.docs_html_by_category(environment="internal", cloud_environment=args.cloud_environment)
# Filter out documents with "disable_import": True
for category, services in docs['categories'].items():