Compare commits

..

1 Commits

Author SHA1 Message Date
6f74306bcf add api-ref for dbss
All checks were successful
gl/check check status: success (6f74306bcf8a52d7f69f617b5ab43409dcfd9501)
gl/gate gate status: success (6f74306bcf8a52d7f69f617b5ab43409dcfd9501)
2024-11-21 11:38:47 +00:00
41 changed files with 71 additions and 53 deletions

View File

@ -2,7 +2,7 @@
hc_location: api/drs hc_location: api/drs
html_location: docs/drs/api-ref html_location: docs/drs/api-ref
link: /data-replication-service/api-ref/ link: /data-replication-service/api-ref/
pdf_enabled: true pdf_name: drs-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: drs service_type: drs
title: API Reference title: API Reference

View File

@ -3,7 +3,7 @@ hc_location: bestpractice/drs
environment: internal environment: internal
html_location: docs/drs/best-practice html_location: docs/drs/best-practice
link: /data-replication-service/best-practice/ link: /data-replication-service/best-practice/
pdf_enabled: true pdf_name: drs-best-practice
rst_location: doc/best-practice/source rst_location: doc/best-practice/source
service_type: drs service_type: drs
title: Best Practice title: Best Practice

View File

@ -2,7 +2,7 @@
hc_location: usermanual/drs hc_location: usermanual/drs
html_location: docs/drs/umn html_location: docs/drs/umn
link: /data-replication-service/umn/ link: /data-replication-service/umn/
pdf_enabled: true pdf_name: drs-umn
rst_location: umn/source rst_location: umn/source
service_type: drs service_type: drs
title: User Guide title: User Guide

View File

@ -2,7 +2,7 @@
hc_location: api/dws hc_location: api/dws
html_location: docs/dws/api-ref html_location: docs/dws/api-ref
link: /data-warehouse-service/api-ref/ link: /data-warehouse-service/api-ref/
pdf_enabled: true pdf_name: dws-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: dws service_type: dws
title: API Reference title: API Reference

View File

@ -2,7 +2,7 @@
hc_location: devg/dws hc_location: devg/dws
html_location: docs/dws/dev html_location: docs/dws/dev
link: /data-warehouse-service/dev-guide/ link: /data-warehouse-service/dev-guide/
pdf_enabled: true pdf_name: dws-dev-guide
rst_location: dev_guide/source rst_location: dev_guide/source
service_type: dws service_type: dws
title: Developer Guide title: Developer Guide

View File

@ -2,7 +2,7 @@
hc_location: tg/dws hc_location: tg/dws
html_location: docs/dws/tool html_location: docs/dws/tool
link: /data-warehouse-service/tool-guide/ link: /data-warehouse-service/tool-guide/
pdf_enabled: true pdf_name: dws-tool-guide
rst_location: doc/tool/source rst_location: doc/tool/source
service_type: dws service_type: dws
title: Tool Guide title: Tool Guide

View File

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

View File

@ -2,7 +2,7 @@
hc_location: api/ecs hc_location: api/ecs
html_location: docs/ecs/api-ref html_location: docs/ecs/api-ref
link: /elastic-cloud-server/api-ref/ link: /elastic-cloud-server/api-ref/
pdf_enabled: true pdf_name: ecs-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: ecs service_type: ecs
title: API Reference title: API Reference

View File

@ -3,7 +3,7 @@ hc_location: bestpractice/ecs
environment: internal environment: internal
html_location: docs/ecs/best-practice html_location: docs/ecs/best-practice
link: /elastic-cloud-server/best-practice/ link: /elastic-cloud-server/best-practice/
pdf_enabled: true pdf_name: ecs-best-practice
rst_location: doc/best-practice/source rst_location: doc/best-practice/source
service_type: ecs service_type: ecs
title: Best Practice title: Best Practice

View File

@ -2,7 +2,7 @@
hc_location: devg/ecs hc_location: devg/ecs
html_location: docs/ecs/dev html_location: docs/ecs/dev
link: /elastic-cloud-server/dev-guide/ link: /elastic-cloud-server/dev-guide/
pdf_enabled: true pdf_name: ecs-dev-guide
rst_location: dev_guide/source rst_location: dev_guide/source
service_type: ecs service_type: ecs
title: Developer Guide title: Developer Guide

View File

@ -2,7 +2,7 @@
hc_location: usermanual/ecs hc_location: usermanual/ecs
html_location: docs/ecs/umn html_location: docs/ecs/umn
link: /elastic-cloud-server/umn/ link: /elastic-cloud-server/umn/
pdf_enabled: true pdf_name: ecs-umn
rst_location: umn/source rst_location: umn/source
service_type: ecs service_type: ecs
title: User Guide title: User Guide

View File

@ -1,6 +1,5 @@
--- ---
link: /enterprise-dashboard/api-ref/ link: /enterprise-dashboard/api-ref/
pdf_enabled: true
rst_location: api-ref/source rst_location: api-ref/source
service_type: ed service_type: ed
title: API Reference title: API Reference

View File

@ -1,6 +1,5 @@
--- ---
link: /enterprise-dashboard/umn/ link: /enterprise-dashboard/umn/
pdf_enabled: true
rst_location: umn/source rst_location: umn/source
service_type: ed service_type: ed
title: User Guide title: User Guide

View File

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

View File

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

View File

@ -2,7 +2,7 @@
hc_location: api/elb hc_location: api/elb
html_location: docs/elb/api-ref html_location: docs/elb/api-ref
link: /elastic-load-balancing/api-ref/ link: /elastic-load-balancing/api-ref/
pdf_enabled: true pdf_name: elb-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: elb service_type: elb
title: API Reference title: API Reference

View File

@ -3,7 +3,7 @@ hc_location: bestpractice/elb
environment: internal environment: internal
html_location: docs/elb/best-practice html_location: docs/elb/best-practice
link: /elastic-load-balancing/best-practice/ link: /elastic-load-balancing/best-practice/
pdf_enabled: true pdf_name: elb-best-practice
rst_location: doc/best-practice/source rst_location: doc/best-practice/source
service_type: elb service_type: elb
title: Best Practice title: Best Practice

View File

@ -2,7 +2,7 @@
hc_location: usermanual/elb hc_location: usermanual/elb
html_location: docs/elb/umn html_location: docs/elb/umn
link: /elastic-load-balancing/umn/ link: /elastic-load-balancing/umn/
pdf_enabled: true pdf_name: elb-umn
rst_location: umn/source rst_location: umn/source
service_type: elb service_type: elb
title: User Guide title: User Guide

View File

@ -3,7 +3,7 @@ environment: internal
hc_location: api/em hc_location: api/em
html_location: docs/eps/api-ref html_location: docs/eps/api-ref
link: /enterprise-project-service/api-ref/ link: /enterprise-project-service/api-ref/
pdf_enabled: true pdf_name: eps-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: eps service_type: eps
title: API Reference title: API Reference

View File

@ -3,7 +3,7 @@ environment: internal
hc_location: usermanual/em hc_location: usermanual/em
html_location: docs/eps/umn html_location: docs/eps/umn
link: /enterprise-project-service/umn/ link: /enterprise-project-service/umn/
pdf_enabled: true pdf_name: eps-umn
rst_location: umn/source rst_location: umn/source
service_type: eps service_type: eps
title: User Guide title: User Guide

View File

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

View File

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

View File

@ -2,7 +2,7 @@
hc_location: api/evs hc_location: api/evs
html_location: docs/evs/api-ref html_location: docs/evs/api-ref
link: /elastic-volume-service/api-ref/ link: /elastic-volume-service/api-ref/
pdf_enabled: true pdf_name: evs-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: evs service_type: evs
title: API Reference title: API Reference

View File

@ -3,7 +3,7 @@ hc_location: bestpractice/evs
environment: internal environment: internal
html_location: docs/evs/best-practice html_location: docs/evs/best-practice
link: /elastic-volume-service/best-practice/ link: /elastic-volume-service/best-practice/
pdf_enabled: true pdf_name: evs-best-practice
rst_location: doc/best-practice/source rst_location: doc/best-practice/source
service_type: evs service_type: evs
title: Best Practice title: Best Practice

View File

@ -2,7 +2,7 @@
hc_location: devg/evs hc_location: devg/evs
html_location: docs/evs/dev html_location: docs/evs/dev
link: /elastic-volume-service/dev-guide/ link: /elastic-volume-service/dev-guide/
pdf_enabled: true pdf_name: evs-dev-guide
rst_location: dev_guide/source rst_location: dev_guide/source
service_type: evs service_type: evs
title: Developer Guide title: Developer Guide

View File

@ -2,7 +2,7 @@
hc_location: usermanual/evs hc_location: usermanual/evs
html_location: docs/evs/umn html_location: docs/evs/umn
link: /elastic-volume-service/umn/ link: /elastic-volume-service/umn/
pdf_enabled: true pdf_name: evs-umn
rst_location: umn/source rst_location: umn/source
service_type: evs service_type: evs
title: User Guide title: User Guide

View File

@ -2,7 +2,7 @@
hc_location: api/functiongraph hc_location: api/functiongraph
html_location: docs/fg/api-ref html_location: docs/fg/api-ref
link: /function-graph/api-ref/ link: /function-graph/api-ref/
pdf_enabled: true pdf_name: fg-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: fg service_type: fg
title: API Reference title: API Reference

View File

@ -3,7 +3,7 @@ hc_location: bestpractice/functiongraph
environment: internal environment: internal
html_location: docs/fg/best-practice html_location: docs/fg/best-practice
link: /function-graph/best-practice/ link: /function-graph/best-practice/
pdf_enabled: true pdf_name: fg-best-practice
rst_location: doc/best-practice/source rst_location: doc/best-practice/source
service_type: fg service_type: fg
title: Best Practice title: Best Practice

View File

@ -3,7 +3,7 @@ hc_location: devg/functiongraph
environment: internal environment: internal
html_location: docs/fg/dev html_location: docs/fg/dev
link: /function-graph/dev-guide/ link: /function-graph/dev-guide/
pdf_enabled: true pdf_name: fg-dev-guide
rst_location: dev_guide/source rst_location: dev_guide/source
service_type: fg service_type: fg
title: Developer Guide title: Developer Guide

View File

@ -2,7 +2,7 @@
hc_location: usermanual/functiongraph hc_location: usermanual/functiongraph
html_location: docs/fg/umn html_location: docs/fg/umn
link: /function-graph/umn/ link: /function-graph/umn/
pdf_enabled: true pdf_name: fg-umn
rst_location: umn/source rst_location: umn/source
service_type: fg service_type: fg
title: User Guide title: User Guide

View File

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

View File

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

View File

@ -1,4 +1,5 @@
--- ---
environment: internal
link: /price-calculator/api-ref/ link: /price-calculator/api-ref/
pdf_name: pc-api-ref pdf_name: pc-api-ref
rst_location: api-ref/source 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

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

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

@ -126,9 +126,9 @@ html_copy_source = False
# -- Options for PDF output -------------------------------------------------- # -- Options for PDF output --------------------------------------------------
latex_documents = [ latex_documents = [
{%- if doc_type %} {%- if pdf_name is defined %}
('index', ('index',
'{{ service_type }}-{{ doc_type }}.tex', '{{ pdf_name }}.tex',
u'{{ title }}', u'{{ title }}',
u'OpenTelekomCloud', 'manual'), u'OpenTelekomCloud', 'manual'),
{% endif -%} {% endif -%}

View File

@ -44,7 +44,7 @@ commands =
{[testenv:json-{{ doc.type }}]commands} {[testenv:json-{{ doc.type }}]commands}
{%- endfor %} {%- endfor %}
[testenv:pdf-docs] [testenv:docs-pdf]
deps = deps =
{[testenv:docs]deps} {[testenv:docs]deps}
{[testenv:bindeps]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/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 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 %} {%- for doc in docs %}
{%- if doc.pdf_enabled %} {%- if doc.pdf_name %}
{[testenv:{{ doc.type }}-pdf-docs]commands} {[testenv:{{ doc.type }}-pdf-docs]commands}
{%- endif %} {%- endif %}
{%- endfor %} {%- endfor %}
@ -107,7 +107,7 @@ commands =
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
{%- endif %} {%- endif %}
{% if doc.pdf_enabled -%} {% if doc.pdf_name -%}
# PDF version # PDF version
[testenv:{{ doc.type }}-pdf-docs] [testenv:{{ doc.type }}-pdf-docs]
deps = {[testenv:docs]deps} 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" 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
mkdir -p doc/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 %} {% endif %}
{% endfor %} {% endfor %}

View File

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

View File

@ -276,7 +276,6 @@ def process_repositories(args, service):
context["docs"].append(doc) context["docs"].append(doc)
context["target_environment"] = args.target_environment context["target_environment"] = args.target_environment
context["service_type"] = service['service_type']
tox_ini_content = tox_ini_template.render(**context) tox_ini_content = tox_ini_template.render(**context)
tox_ini_path = pathlib.Path(copy_to, "tox.ini") tox_ini_path = pathlib.Path(copy_to, "tox.ini")
@ -300,12 +299,6 @@ def process_repositories(args, service):
if args.update_zuul: if args.update_zuul:
"""Update zuul.yaml""" """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_content = zuul_yaml_template.render(**context)
zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml") zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")