forked from infra/otc-metadata
Compare commits
17 Commits
enable_pdf
...
main
Author | SHA1 | Date | |
---|---|---|---|
99417a5410 | |||
b0e7932806 | |||
766bc0dda4 | |||
07c4edd503 | |||
dbc6d6d400 | |||
7ad18dfa57 | |||
6f9af80531 | |||
879317eb6f | |||
efe7f283d5 | |||
c3a51e8aeb | |||
f9c18fb99e | |||
1063bffd55 | |||
25a089107c | |||
a866e9829d | |||
0a53ed9072 | |||
f26e1f24ca | |||
1d365ecc8c |
@ -1,5 +1,4 @@
|
||||
---
|
||||
environment: internal
|
||||
hc_location: api-usage/guidelines
|
||||
html_location: docs/apiu/guidelines
|
||||
link: /api-usage/guidelines/
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
environment: internal
|
||||
environment: public
|
||||
hc_location: api/asm
|
||||
html_location: docs/asm/api-ref
|
||||
link: /application-service-mesh/api-ref/
|
||||
|
@ -1,5 +1,4 @@
|
||||
---
|
||||
environment: internal
|
||||
hc_location: api/cfw
|
||||
html_location: docs/cfw/api-ref
|
||||
link: /cloud-firewall/api-ref/
|
||||
|
@ -1,5 +1,4 @@
|
||||
---
|
||||
environment: internal
|
||||
hc_location: usermanual/cfw
|
||||
html_location: docs/cfw/umn
|
||||
link: /cloud-firewall/umn/
|
||||
|
11
otc_metadata/data/documents/das-api-ref.yaml
Normal file
11
otc_metadata/data/documents/das-api-ref.yaml
Normal 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
|
11
otc_metadata/data/documents/das-umn.yaml
Normal file
11
otc_metadata/data/documents/das-umn.yaml
Normal 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
|
@ -1,4 +1,5 @@
|
||||
---
|
||||
environment: internal
|
||||
hc_location: api/dbss
|
||||
html_location: docs/dbss/api-ref
|
||||
link: /database-security-service/api-ref/
|
||||
|
@ -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
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
environment: internal
|
||||
environment: hidden
|
||||
repositories:
|
||||
- environment: internal
|
||||
repo: docs/api-usage
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
environment: internal
|
||||
environment: public
|
||||
repositories:
|
||||
- environment: internal
|
||||
repo: docs/cloud-firewall
|
||||
|
16
otc_metadata/data/services/das.yaml
Normal file
16
otc_metadata/data/services/das.yaml
Normal 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
|
@ -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
|
||||
|
@ -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]
|
||||
|
@ -167,8 +167,17 @@ 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"
|
||||
and target_repo["repo"].split("/")[0] == "docs-swiss"):
|
||||
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,
|
||||
site_name="Internal Documentation Portal",
|
||||
@ -224,8 +233,17 @@ 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"
|
||||
and target_repo["repo"].split("/")[0] == "docs-swiss"):
|
||||
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,
|
||||
site_name="Internal Documentation Portal",
|
||||
|
Loading…
x
Reference in New Issue
Block a user