Compare commits

..

1 Commits

Author SHA1 Message Date
f4506b2141 adding constraints reference
All checks were successful
gl/check check status: success (f4506b2141ff8f2def622023d54b4111ef9d91d5)
gl/gate gate status: success (f4506b2141ff8f2def622023d54b4111ef9d91d5)
2023-08-09 11:33:40 +00:00
5 changed files with 6 additions and 103 deletions

View File

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

View File

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

View File

@ -122,58 +122,6 @@ class Services(object):
res[cat]["docs"].append(res_doc) res[cat]["docs"].append(res_doc)
return res 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): def docs_by_service_category(self, category, environment=None):
"""List services matching category """List services matching category
@ -237,8 +185,6 @@ class Services(object):
srv_res = dict( srv_res = dict(
service_title=srv["service_title"], service_title=srv["service_title"],
service_type=srv["service_type"], service_type=srv["service_type"],
service_category=srv["service_category"],
service_environment=environment,
docs=[], docs=[],
) )
if "teams" in srv: if "teams" in srv:
@ -262,7 +208,6 @@ class Services(object):
rst_location=doc["rst_location"], rst_location=doc["rst_location"],
title=doc["title"], title=doc["title"],
type=doc.get("type", "dummy"), type=doc.get("type", "dummy"),
link=doc["link"],
) )
if "pdf_name" in doc: if "pdf_name" in doc:
doc_res["pdf_name"] = doc["pdf_name"] doc_res["pdf_name"] = doc["pdf_name"]

View File

@ -26,6 +26,7 @@ extensions = [
otcdocs_auto_name = False otcdocs_auto_name = False
otcdocs_auto_version = False otcdocs_auto_version = False
otcdocs_search_environment = 'hc_swiss'
project = '{{ project }}' project = '{{ project }}'
otcdocs_repo_name = '{{ repo_name }}' otcdocs_repo_name = '{{ repo_name }}'
@ -37,17 +38,6 @@ otcdocs_git_fqdn = '{{ git_fqdn }}'
otcdocs_git_type = '{{ git_type }}' otcdocs_git_type = '{{ git_type }}'
{%- endif %} {%- 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_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

View File

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