Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 75d5209789 | |||
| 016b67221c | |||
| a7ee45b3d8 | |||
| c0a83341f4 | |||
| f9076808e2 | |||
| e3ce9a281f | |||
| 2884d277b5 | |||
| a5f4e1a836 | |||
| c2ef8fab62 | |||
| d82b382a7b | |||
| 94752c28a0 | |||
| f9ca3d02a7 | |||
| 50ed3a6611 | |||
| 1886623430 | |||
| 8a781ee62a |
@ -1,11 +0,0 @@
|
||||
---
|
||||
hc_location: bestpractice/blueprints
|
||||
environment: internal
|
||||
html_location: docs/blueprints/best-practice
|
||||
link: /blueprints/best-practice/
|
||||
pdf_name: blueprints-best-practice
|
||||
rst_location: doc/best-practice/source
|
||||
service_type: blueprints
|
||||
title: Best Practice
|
||||
type: best-practice
|
||||
disable_import: true
|
||||
9
otc_metadata/data/documents/dbss-api-ref.yaml
Normal file
9
otc_metadata/data/documents/dbss-api-ref.yaml
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
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
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
environment: internal
|
||||
hc_location: api/nosql
|
||||
html_location: docs/gaussdb_nosql/api-ref
|
||||
link: /gaussdb-nosql/api-ref/
|
||||
pdf_name: gaussdb_nosql-api-ref
|
||||
rst_location: api-ref/source
|
||||
service_type: gaussdb_nosql
|
||||
title: API Reference
|
||||
type: api-ref
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
environment: internal
|
||||
hc_location: usermanual/nosql
|
||||
html_location: docs/gaussdb_nosql/umn
|
||||
link: /gaussdb-nosql/umn/
|
||||
pdf_name: gauss_nosql
|
||||
rst_location: umn/source
|
||||
service_type: gaussdb_nosql
|
||||
title: User Guide
|
||||
type: umn
|
||||
@ -2,7 +2,7 @@
|
||||
hc_location: api/nosql
|
||||
html_location: docs/geminidb/api-ref
|
||||
link: /geminidb/api-ref/
|
||||
pdf_name: geminidb-api-ref
|
||||
pdf_enabled: true
|
||||
rst_location: api-ref/source
|
||||
service_type: geminidb
|
||||
title: API Reference
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
hc_location: usermanual/nosql
|
||||
html_location: docs/geminidb/umn
|
||||
link: /geminidb/umn/
|
||||
pdf_name: geminidb-umn
|
||||
pdf_enabled: true
|
||||
rst_location: umn/source
|
||||
service_type: geminidb
|
||||
title: User Guide
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
---
|
||||
environment: internal
|
||||
link: /price-calculator/api-ref/
|
||||
pdf_name: pc-api-ref
|
||||
rst_location: api-ref/source
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
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
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
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
|
||||
@ -12,5 +12,5 @@ service_title: Application Operations Management
|
||||
service_type: aom
|
||||
service_uri: application-operations-management
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Application Operations Management 2.0
|
||||
service_type: aom2
|
||||
service_uri: application-operations-management-2
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: API Gateway (APIG)
|
||||
service_type: apig
|
||||
service_uri: api-gateway
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -7,10 +7,10 @@ repositories:
|
||||
- environment: public
|
||||
repo: opentelekomcloud-docs/application-performance-management
|
||||
type: github
|
||||
service_category: md
|
||||
service_category: application
|
||||
service_title: Application Performance Management
|
||||
service_type: apm
|
||||
service_uri: application-performance-management
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
environment: hidden
|
||||
repositories:
|
||||
- environment: internal
|
||||
repo: docs/blueprints
|
||||
type: gitea
|
||||
- environment: public
|
||||
repo: opentelekomcloud-docs/blueprints
|
||||
type: github
|
||||
service_category: other
|
||||
service_title: Blueprints
|
||||
service_type: blueprints
|
||||
service_uri: blueprints
|
||||
teams:
|
||||
- name: eco
|
||||
permission: write
|
||||
@ -12,5 +12,5 @@ service_title: Cloud Eye
|
||||
service_type: ces
|
||||
service_uri: cloud-eye
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-cms-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Config
|
||||
service_type: config
|
||||
service_uri: config
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-cms-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Cloud Service Engine
|
||||
service_type: cse
|
||||
service_uri: cloud-service-engine
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Cloud Trace Service
|
||||
service_type: cts
|
||||
service_uri: cloud-trace-service
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Distributed Cache Service
|
||||
service_type: dcs
|
||||
service_uri: distributed-cache-service
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Distributed Message Service
|
||||
service_type: dms
|
||||
service_uri: distributed-message-service
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -1,9 +1,6 @@
|
||||
---
|
||||
environment: public
|
||||
repositories:
|
||||
- environment: internal
|
||||
repo: docs/enterprise-dashboard
|
||||
type: gitea
|
||||
- environment: public
|
||||
repo: opentelekomcloud-docs/enterprise-dashboard
|
||||
type: github
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: FunctionGraph
|
||||
service_type: fg
|
||||
service_uri: function-graph
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
environment: internal
|
||||
repositories:
|
||||
- environment: internal
|
||||
repo: docs/gaussdb-nosql
|
||||
type: gitea
|
||||
- environment: public
|
||||
repo: opentelekomcloud-docs/gaussdb-nosql
|
||||
type: github
|
||||
service_category: database
|
||||
service_title: GaussDB NoSQL
|
||||
service_type: gaussdb_nosql
|
||||
service_uri: gaussdb-nosql
|
||||
teams:
|
||||
- name: docs-database-rw
|
||||
permission: write
|
||||
@ -12,5 +12,5 @@ service_title: Log Tank Service
|
||||
service_type: lts
|
||||
service_uri: log-tank-service
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-paas-rw
|
||||
permission: write
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
environment: hidden
|
||||
environment: public
|
||||
repositories:
|
||||
- environment: internal
|
||||
repo: docs/price-calculator
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Resource Formation Service
|
||||
service_type: rfs
|
||||
service_uri: resource-formation-service
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-cms-rw
|
||||
permission: write
|
||||
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
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
|
||||
@ -12,5 +12,5 @@ service_title: Simple Message Notification
|
||||
service_type: smn
|
||||
service_uri: simple-message-notification
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-cms-rw
|
||||
permission: write
|
||||
|
||||
@ -12,5 +12,5 @@ service_title: Tag Management Service
|
||||
service_type: tms
|
||||
service_uri: tag-management-service
|
||||
teams:
|
||||
- name: docs-orchestration-rw
|
||||
- name: docs-cms-rw
|
||||
permission: write
|
||||
|
||||
@ -126,9 +126,9 @@ html_copy_source = False
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = [
|
||||
{%- if pdf_name is defined %}
|
||||
{%- if doc_type %}
|
||||
('index',
|
||||
'{{ pdf_name }}.tex',
|
||||
'{{ service_type }}-{{ doc_type }}.tex',
|
||||
u'{{ title }}',
|
||||
u'OpenTelekomCloud', 'manual'),
|
||||
{% endif -%}
|
||||
@ -144,6 +144,11 @@ latex_elements = {
|
||||
'papersize': 'a4paper',
|
||||
'pointsize': '12pt',
|
||||
'figure_align': 'H',
|
||||
'preamble': r'\newcommand{\githash}{' + current_commit_hash + '}',
|
||||
'preamble': rf'''{% raw %}
|
||||
\newcommand{{\githash}}{{{current_commit_hash}}}
|
||||
\newcommand{{\gitcommittime}}{{{current_commit_time}}}
|
||||
\newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
|
||||
\newcommand{{\servicetitle}}{{{otcdocs_service_title}}}{% endraw %}
|
||||
''',
|
||||
'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
|
||||
}
|
||||
|
||||
@ -44,7 +44,7 @@ commands =
|
||||
{[testenv:json-{{ doc.type }}]commands}
|
||||
{%- endfor %}
|
||||
|
||||
[testenv:docs-pdf]
|
||||
[testenv:pdf-docs]
|
||||
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_name %}
|
||||
{%- if doc.pdf_enabled %}
|
||||
{[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_name -%}
|
||||
{% if doc.pdf_enabled -%}
|
||||
# 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/{{ doc.pdf_name }}.pdf doc/build/pdf/
|
||||
cp {{ loc }}/build/pdf/{{ service_type }}-{{ doc.type }}.pdf doc/build/pdf/
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
|
||||
@ -4,6 +4,13 @@
|
||||
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
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user