Compare commits

..

18 Commits

Author SHA1 Message Date
99417a5410 make ASM api-ref public
Reviewed-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2025-03-10 18:58:07 +00:00
b0e7932806 Changing service category RFS
Reviewed-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-authored-by: Natalia Bobkova <natalia.bobkova@t-systems.com>
Co-committed-by: Natalia Bobkova <natalia.bobkova@t-systems.com>
2025-03-06 12:42:44 +00:00
766bc0dda4 making api usage guidelines public
Reviewed-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2025-03-04 08:38:55 +00:00
07c4edd503 Swiss confpy changes
Reviewed-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2025-02-25 11:25:08 +00:00
dbc6d6d400 RFS-API to internal
Reviewed-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2025-02-20 08:30:11 +00:00
7ad18dfa57 RFS to public
Reviewed-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2025-02-19 17:54:07 +00:00
6f9af80531 rfs tags hidden
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Natalia Bobkova <natalia.bobkova@t-systems.com>
Co-committed-by: Natalia Bobkova <natalia.bobkova@t-systems.com>
2025-02-14 12:59:57 +00:00
879317eb6f Update otc_metadata/data/documents/dbss-api-ref.yaml
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2025-02-14 08:48:39 +00:00
efe7f283d5 revert Python 3.11
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2025-02-13 10:33:31 +00:00
c3a51e8aeb Basepython to 3.11
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2025-02-12 14:41:43 +00:00
f9c18fb99e New service Data Admin Service
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: lboka <ladislav.boka@t-systems.com>
Co-committed-by: lboka <ladislav.boka@t-systems.com>
2025-02-07 13:10:49 +00:00
1063bffd55 Auto copy PDFs to HTML folder for Zuul to upload
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2025-02-07 10:14:06 +00:00
25a089107c Update tox.ini to no interactive latex-mode and only use first image of animated gif
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2025-02-04 13:11:50 +00:00
a866e9829d Disable PDF rendering on services without documents
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2025-01-21 08:29:26 +00:00
0a53ed9072 cfw docs
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: lbelejka <lukas.belejkanic@t-systems.com>
Co-committed-by: lbelejka <lukas.belejkanic@t-systems.com>
2025-01-20 12:45:10 +00:00
f26e1f24ca activate that pdf jobs are visible in tox.ini without activating them
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2025-01-17 13:30:25 +00:00
1d365ecc8c activate pdf for CSS service
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2025-01-17 13:28:55 +00:00
1529742878 adding cloud connect service
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2025-01-14 08:27:08 +00:00
18 changed files with 78 additions and 22 deletions

View File

@ -1,5 +1,4 @@
---
environment: internal
hc_location: api-usage/guidelines
html_location: docs/apiu/guidelines
link: /api-usage/guidelines/

View File

@ -1,5 +1,5 @@
---
environment: internal
environment: public
hc_location: api/asm
html_location: docs/asm/api-ref
link: /application-service-mesh/api-ref/

View File

@ -1,5 +1,4 @@
---
environment: internal
hc_location: api/cfw
html_location: docs/cfw/api-ref
link: /cloud-firewall/api-ref/

View File

@ -1,5 +1,4 @@
---
environment: internal
hc_location: usermanual/cfw
html_location: docs/cfw/umn
link: /cloud-firewall/umn/

View File

@ -2,7 +2,7 @@
hc_location: api/css
html_location: docs/css/api-ref
link: /cloud-search-service/api-ref/
pdf_enabled: false
pdf_enabled: true
pdf_environment: internal
rst_location: api-ref/source
service_type: css

View File

@ -2,7 +2,7 @@
hc_location: bestpractice/css
html_location: docs/css/best-practice
link: /cloud-search-service/best-practice/
pdf_enabled: false
pdf_enabled: true
pdf_environment: internal
rst_location: doc/best-practice/source
service_type: css

View File

@ -2,7 +2,7 @@
hc_location: usermanual/css
html_location: docs/css/umn
link: /cloud-search-service/umn/
pdf_enabled: false
pdf_enabled: true
pdf_environment: internal
rst_location: umn/source
service_type: css

View File

@ -0,0 +1,11 @@
---
hc_location: api/das
environment: internal
html_location: docs/das/api-ref
link: /data-admin-service/api-ref/
pdf_enabled: true
pdf_environment: internal
rst_location: api-ref/source
service_type: das
title: API Reference
type: api-ref

View File

@ -0,0 +1,11 @@
---
hc_location: usermanual/das
environment: internal
html_location: docs/das/umn
link: /data-admin-service/umn/
pdf_enabled: true
pdf_environment: internal
rst_location: umn/source
service_type: das
title: User Guide
type: umn

View File

@ -1,4 +1,5 @@
---
environment: internal
hc_location: api/dbss
html_location: docs/dbss/api-ref
link: /database-security-service/api-ref/

View File

@ -1,10 +1,10 @@
---
hc_location: usermanual/aos
environment: internal
environment: public
html_location: docs/rfs/umn
link: /resource-formation-service/umn/
pdf_enabled: true
pdf_environment: internal
pdf_enabled: true
rst_location: umn/source
service_type: rfs
title: User Guide

View File

@ -1,5 +1,5 @@
---
environment: internal
environment: hidden
repositories:
- environment: internal
repo: docs/api-usage

View File

@ -1,5 +1,5 @@
---
environment: internal
environment: public
repositories:
- environment: internal
repo: docs/cloud-firewall

View File

@ -0,0 +1,16 @@
---
environment: internal
repositories:
- environment: internal
repo: docs/data-admin-service
type: gitea
- environment: public
repo: opentelekomcloud-docs/data-admin-service
type: github
service_category: database
service_title: Data Admin Service
service_type: das
service_uri: data-admin-service
teams:
- name: docs-database-rw
permission: write

View File

@ -1,5 +1,5 @@
---
environment: internal
environment: public
repositories:
- environment: internal
repo: docs/resource-formation-service
@ -7,7 +7,7 @@ repositories:
- environment: public
repo: opentelekomcloud-docs/resource-formation-service
type: github
service_category: application
service_category: md
service_title: Resource Formation Service
service_type: rfs
service_uri: resource-formation-service

View File

@ -44,6 +44,7 @@ commands =
{[testenv:json-{{ doc.type }}]commands}
{%- endfor %}
{% if docs|length > 0 %}
[testenv:pdf-docs]
deps =
{[testenv:docs]deps}
@ -57,6 +58,7 @@ allowlist_externals =
cp
commands =
mkdir -p doc/build/pdf
mkdir -p doc/build/html
{[testenv:bindeps]commands}
mkdir -p {toxinidir}/_templates
wget -O {toxinidir}/_templates/longtable.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/longtable.tex.jinja
@ -67,6 +69,7 @@ commands =
{[testenv:{{ doc.type }}-pdf-docs]commands}
{%- endif %}
{%- endfor %}
{% endif %}
{% for doc in docs -%}
{% set loc = doc.rst_location | replace('/source', '') %}
@ -107,7 +110,6 @@ commands =
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
{%- endif %}
{% if doc.pdf_enabled -%}
# PDF version
[testenv:{{ doc.type }}-pdf-docs]
deps = {[testenv:docs]deps}
@ -121,12 +123,12 @@ commands =
rm -rf {{ loc }}/build/pdf
cp -r {toxinidir}/_templates {{ loc }}/source/_templates/
sphinx-build -W --keep-going -b latex {{ loc }}/source {{ loc }}/build/pdf/
bash -c "for f in {{ loc }}/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
bash -c "for f in {{ loc }}/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
bash -c "for f in {{ loc }}/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
make -C {{ loc }}/build/pdf
make -C {{ loc }}/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
mkdir -p doc/build/pdf
cp {{ loc }}/build/pdf/{{ service_type }}-{{ doc.type }}.pdf doc/build/pdf/
{% endif %}
cp {{ loc }}/build/pdf/{{ service_type }}-{{ doc.type }}.pdf doc/build/html/
{% endfor %}
[testenv:bindeps]

View File

@ -167,7 +167,16 @@ def process_repositories(args, service):
context["git_fqdn"] = git_fqdn
if target_repo.get("type") != "github":
context["git_type"] = target_repo["type"]
if (args.target_environment == "internal"
if (args.target_environment == "public"
and target_repo["repo"].split("/")[0] == "opentelekomcloud-docs-swiss"):
context["html_options"] = dict(
logo_url="https://docs.sc.otc.t-systems.com",
)
elif (args.target_environment == "public"):
context["html_options"] = dict(
logo_url="https://docs.otc.t-systems.com",
)
elif (args.target_environment == "internal"
and target_repo["repo"].split("/")[0] == "docs-swiss"):
context["html_options"] = dict(
disable_search=True,
@ -224,7 +233,16 @@ def process_repositories(args, service):
context["git_fqdn"] = git_fqdn
if target_repo.get("type") != "github":
context["git_type"] = target_repo["type"]
if (args.target_environment == "internal"
if (args.target_environment == "public"
and target_repo["repo"].split("/")[0] == "opentelekomcloud-docs-swiss"):
context["html_options"] = dict(
logo_url="https://docs.sc.otc.t-systems.com",
)
elif (args.target_environment == "public"):
context["html_options"] = dict(
logo_url="https://docs.otc.t-systems.com",
)
elif (args.target_environment == "internal"
and target_repo["repo"].split("/")[0] == "docs-swiss"):
context["html_options"] = dict(
disable_search=True,

View File

@ -20,6 +20,6 @@ commands = {posargs}
[flake8]
# E123, E125 skipped as they are invalid PEP-8.
show-source = True
ignore = E123,E125,W503
ignore = E123,E125,W503,E501
builtins = _
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build