Compare commits

..

3 Commits

Author SHA1 Message Date
21cc170225 fix pep8
All checks were successful
gl/check check status: success (21cc17022518ed0e29fea32dfecd41af6c8d5fba)
gl/gate gate status: success (21cc17022518ed0e29fea32dfecd41af6c8d5fba)
2024-10-30 10:18:46 +00:00
a882f93e8e Fix swiss int logo link
Some checks failed
gl/check check status: failure (a882f93e8e3ec56e6f47e649794e0f71d0af30ca)
2024-10-18 09:57:43 +00:00
2be2e7b88d Fix error handling on confpy script
All checks were successful
gl/check check status: success (2be2e7b88db530722c886f9476df6479e6d6b310)
2024-10-17 12:12:43 +00:00
28 changed files with 64 additions and 54 deletions

View File

@ -1,9 +0,0 @@
---
hc_location: api/dbss
html_location: docs/dbss/api-ref
link: /database-security-service/api-ref/
pdf_name: dbss-api-ref
rst_location: api-ref/source
service_type: dbss
title: API Reference
type: api-ref

View File

@ -2,7 +2,7 @@
hc_location: api/nosql
html_location: docs/geminidb/api-ref
link: /geminidb/api-ref/
pdf_enabled: true
pdf_name: geminidb-api-ref
rst_location: api-ref/source
service_type: geminidb
title: API Reference

View File

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

View File

@ -1,4 +1,5 @@
---
environment: internal
link: /price-calculator/api-ref/
pdf_name: pc-api-ref
rst_location: api-ref/source

View File

@ -0,0 +1,9 @@
---
hc_location: api/rms
html_location: docs/rms/api-ref
link: /resource-management-service/api-ref/
pdf_name: rms-api-ref
rst_location: api-ref/source
service_type: rms
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/rms
html_location: docs/rms/umn
link: /resource-management-service/umn/
pdf_name: rms-umn
rst_location: umn/source
service_type: rms
title: User Guide
type: umn

View File

@ -12,5 +12,5 @@ service_title: Application Operations Management
service_type: aom
service_uri: application-operations-management
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Application Operations Management 2.0
service_type: aom2
service_uri: application-operations-management-2
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: API Gateway (APIG)
service_type: apig
service_uri: api-gateway
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -7,10 +7,10 @@ repositories:
- environment: public
repo: opentelekomcloud-docs/application-performance-management
type: github
service_category: application
service_category: md
service_title: Application Performance Management
service_type: apm
service_uri: application-performance-management
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Cloud Eye
service_type: ces
service_uri: cloud-eye
teams:
- name: docs-cms-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Config
service_type: config
service_uri: config
teams:
- name: docs-cms-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Cloud Service Engine
service_type: cse
service_uri: cloud-service-engine
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Cloud Trace Service
service_type: cts
service_uri: cloud-trace-service
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Distributed Cache Service
service_type: dcs
service_uri: distributed-cache-service
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Distributed Message Service
service_type: dms
service_uri: distributed-message-service
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -1,6 +1,9 @@
---
environment: public
repositories:
- environment: internal
repo: docs/enterprise-dashboard
type: gitea
- environment: public
repo: opentelekomcloud-docs/enterprise-dashboard
type: github

View File

@ -12,5 +12,5 @@ service_title: FunctionGraph
service_type: fg
service_uri: function-graph
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Log Tank Service
service_type: lts
service_uri: log-tank-service
teams:
- name: docs-paas-rw
- name: docs-orchestration-rw
permission: write

View File

@ -1,5 +1,5 @@
---
environment: public
environment: hidden
repositories:
- environment: internal
repo: docs/price-calculator

View File

@ -12,5 +12,5 @@ service_title: Resource Formation Service
service_type: rfs
service_uri: resource-formation-service
teams:
- name: docs-cms-rw
- name: docs-orchestration-rw
permission: write

View File

@ -0,0 +1,16 @@
---
environment: public
repositories:
- environment: internal
repo: docs/resource-management-service
type: gitea
- environment: public
repo: opentelekomcloud-docs/resource-management-service
type: github
service_category: md
service_title: Resource Management Service
service_type: rms
service_uri: resource-management-service
teams:
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Simple Message Notification
service_type: smn
service_uri: simple-message-notification
teams:
- name: docs-cms-rw
- name: docs-orchestration-rw
permission: write

View File

@ -12,5 +12,5 @@ service_title: Tag Management Service
service_type: tms
service_uri: tag-management-service
teams:
- name: docs-cms-rw
- name: docs-orchestration-rw
permission: write

View File

@ -126,9 +126,9 @@ html_copy_source = False
# -- Options for PDF output --------------------------------------------------
latex_documents = [
{%- if doc_type %}
{%- if pdf_name is defined %}
('index',
'{{ service_type }}-{{ doc_type }}.tex',
'{{ pdf_name }}.tex',
u'{{ title }}',
u'OpenTelekomCloud', 'manual'),
{% endif -%}
@ -144,11 +144,6 @@ latex_elements = {
'papersize': 'a4paper',
'pointsize': '12pt',
'figure_align': 'H',
'preamble': rf'''{% raw %}
\newcommand{{\githash}}{{{current_commit_hash}}}
\newcommand{{\gitcommittime}}{{{current_commit_time}}}
\newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
\newcommand{{\servicetitle}}{{{otcdocs_service_title}}}{% endraw %}
''',
'preamble': r'\newcommand{\githash}{' + current_commit_hash + '}',
'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
}

View File

@ -44,7 +44,7 @@ commands =
{[testenv:json-{{ doc.type }}]commands}
{%- endfor %}
[testenv:pdf-docs]
[testenv:docs-pdf]
deps =
{[testenv:docs]deps}
{[testenv:bindeps]deps}
@ -63,7 +63,7 @@ commands =
wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja
wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja
{%- for doc in docs %}
{%- if doc.pdf_enabled %}
{%- if doc.pdf_name %}
{[testenv:{{ doc.type }}-pdf-docs]commands}
{%- endif %}
{%- endfor %}
@ -107,7 +107,7 @@ commands =
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
{%- endif %}
{% if doc.pdf_enabled -%}
{% if doc.pdf_name -%}
# PDF version
[testenv:{{ doc.type }}-pdf-docs]
deps = {[testenv:docs]deps}
@ -125,7 +125,7 @@ commands =
bash -c "for f in {{ loc }}/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
make -C {{ loc }}/build/pdf
mkdir -p doc/build/pdf
cp {{ loc }}/build/pdf/{{ service_type }}-{{ doc.type }}.pdf doc/build/pdf/
cp {{ loc }}/build/pdf/{{ doc.pdf_name }}.pdf doc/build/pdf/
{% endif %}
{% endfor %}

View File

@ -4,13 +4,6 @@
default-branch: main
templates:
- helpcenter-base-jobs
vars:
sphinx_pdf_files:
{%- for doc in docs %}
{%- if doc.pdf_enabled %}
- {{ service_type }}-{{ doc.type }}.pdf
{%- endif %}
{%- endfor %}
check:
jobs:
- noop

View File

@ -276,7 +276,6 @@ def process_repositories(args, service):
context["docs"].append(doc)
context["target_environment"] = args.target_environment
context["service_type"] = service['service_type']
tox_ini_content = tox_ini_template.render(**context)
tox_ini_path = pathlib.Path(copy_to, "tox.ini")
@ -300,12 +299,6 @@ def process_repositories(args, service):
if args.update_zuul:
"""Update zuul.yaml"""
context = dict(docs=[])
for doc in service_docs:
if doc["type"] == "dev":
doc["type"] = "dev-guide"
context["docs"].append(doc)
context["service_type"] = service['service_type']
zuul_yaml_content = zuul_yaml_template.render(**context)
zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")