Compare commits
18 Commits
Author | SHA1 | Date | |
---|---|---|---|
be58acc4ed | |||
ef7985a733 | |||
28a1c05d34 | |||
1d8f91ff0b | |||
efecf2237d | |||
ba4d942a1e | |||
bda2e6aa21 | |||
b9d235abc0 | |||
f06f533823 | |||
b4290744e3 | |||
293b2c3995 | |||
dd208417ed | |||
66723e88e7 | |||
a1eeaf4582 | |||
350562863a | |||
130ebd1e3c | |||
dcdd3a11fa | |||
a0cbeab804 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -59,3 +59,6 @@ ChangeLog
|
|||||||
|
|
||||||
# Files created by releasenotes build
|
# Files created by releasenotes build
|
||||||
releasenotes/build
|
releasenotes/build
|
||||||
|
|
||||||
|
bindep.txt
|
||||||
|
packages.txt
|
8
otc_metadata/data/documents/ac-blueprints.yaml
Normal file
8
otc_metadata/data/documents/ac-blueprints.yaml
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
environment: public
|
||||||
|
link: /architecture-center/blueprints/
|
||||||
|
pdf_name: architecture-center-blueprints
|
||||||
|
rst_location: doc/blueprints/source
|
||||||
|
service_type: ac
|
||||||
|
title: Blueprints
|
||||||
|
type: blueprints
|
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
environment: public
|
||||||
|
link: /architecture-center/caf/
|
||||||
|
pdf_name: architecture-center-cloud-adoption-framework
|
||||||
|
rst_location: doc/caf/source
|
||||||
|
service_type: ac
|
||||||
|
title: Cloud Adoption Framework
|
||||||
|
type: caf
|
@ -1,4 +1,5 @@
|
|||||||
---
|
---
|
||||||
|
environment: internal
|
||||||
hc_location: api-usage/guidelines
|
hc_location: api-usage/guidelines
|
||||||
html_location: docs/apiu/guidelines
|
html_location: docs/apiu/guidelines
|
||||||
link: /api-usage/guidelines/
|
link: /api-usage/guidelines/
|
||||||
|
10
otc_metadata/data/documents/blueprints-best-practice.yaml
Normal file
10
otc_metadata/data/documents/blueprints-best-practice.yaml
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
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
|
8
otc_metadata/data/documents/cc-api-ref.yaml
Normal file
8
otc_metadata/data/documents/cc-api-ref.yaml
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
html_location: docs/cc/api-ref
|
||||||
|
link: /cloud-create/api-ref/
|
||||||
|
pdf_name: cc-api-ref
|
||||||
|
rst_location: api-ref/source
|
||||||
|
service_type: cc
|
||||||
|
title: API Reference
|
||||||
|
type: api-ref
|
8
otc_metadata/data/documents/cc-umn.yaml
Normal file
8
otc_metadata/data/documents/cc-umn.yaml
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
html_location: docs/cc/umn
|
||||||
|
link: /cloud-create/umn/
|
||||||
|
pdf_name: cc-umn
|
||||||
|
rst_location: umn/source
|
||||||
|
service_type: cc
|
||||||
|
title: User Guide
|
||||||
|
type: umn
|
10
otc_metadata/data/documents/dli-dev.yaml
Normal file
10
otc_metadata/data/documents/dli-dev.yaml
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
environment: internal
|
||||||
|
hc_location: devg/dli
|
||||||
|
html_location: docs/dli/dev
|
||||||
|
link: /data-lake-insight/dev-guide/
|
||||||
|
pdf_name: dli-dev-guide
|
||||||
|
rst_location: dev_guide/source
|
||||||
|
service_type: dli
|
||||||
|
title: Developer Guide
|
||||||
|
type: dev
|
10
otc_metadata/data/documents/ocr-api-ref.yaml
Normal file
10
otc_metadata/data/documents/ocr-api-ref.yaml
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
hc_location: api/ocr
|
||||||
|
environment: internal
|
||||||
|
html_location: docs/ocr/api-ref
|
||||||
|
link: /optical-character-recognition/api-ref/
|
||||||
|
pdf_name: ocr-api-ref
|
||||||
|
rst_location: api-ref/source
|
||||||
|
service_type: ocr
|
||||||
|
title: API Reference
|
||||||
|
type: api-ref
|
10
otc_metadata/data/documents/ocr-umn.yaml
Normal file
10
otc_metadata/data/documents/ocr-umn.yaml
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
hc_location: usermanual/ocr
|
||||||
|
environment: internal
|
||||||
|
html_location: docs/ocr/umn
|
||||||
|
link: /optical-character-recognition/umn/
|
||||||
|
pdf_name: ocr-umn
|
||||||
|
rst_location: umn/source
|
||||||
|
service_type: ocr
|
||||||
|
title: User Guide
|
||||||
|
type: umn
|
@ -1,9 +0,0 @@
|
|||||||
---
|
|
||||||
hc_location: api/rts
|
|
||||||
html_location: docs/rts/api-ref
|
|
||||||
link: /resource-template-service/api-ref/
|
|
||||||
pdf_name: rts-api-ref
|
|
||||||
rst_location: api-ref/source
|
|
||||||
service_type: rts
|
|
||||||
title: API Reference
|
|
||||||
type: api-ref
|
|
@ -1,9 +0,0 @@
|
|||||||
---
|
|
||||||
hc_location: usermanual/rts
|
|
||||||
html_location: docs/rts/umn
|
|
||||||
link: /resource-template-service/umn/
|
|
||||||
pdf_name: rts-umn
|
|
||||||
rst_location: umn/source
|
|
||||||
service_type: rts
|
|
||||||
title: User Guide
|
|
||||||
type: umn
|
|
@ -1,8 +0,0 @@
|
|||||||
---
|
|
||||||
html_location: docs/tcc/umn
|
|
||||||
link: /telekom-cloud-create/umn/
|
|
||||||
pdf_name: tcc-umn
|
|
||||||
rst_location: umn/source
|
|
||||||
service_type: tcc
|
|
||||||
title: User Guide
|
|
||||||
type: umn
|
|
16
otc_metadata/data/services/ac.yaml
Normal file
16
otc_metadata/data/services/ac.yaml
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
environment: hidden
|
||||||
|
repositories:
|
||||||
|
- environment: internal
|
||||||
|
repo: docs/architecture-center
|
||||||
|
type: gitea
|
||||||
|
- environment: public
|
||||||
|
repo: opentelekomcloud-docs/architecture-center
|
||||||
|
type: github
|
||||||
|
service_category: other
|
||||||
|
service_title: Architecture Center
|
||||||
|
service_type: ac
|
||||||
|
service_uri: architecture-center
|
||||||
|
teams:
|
||||||
|
- name: docs-architecture-center-rw
|
||||||
|
permission: write
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
environment: public
|
environment: internal
|
||||||
repositories:
|
repositories:
|
||||||
- environment: internal
|
- environment: internal
|
||||||
repo: docs/api-usage
|
repo: docs/api-usage
|
||||||
|
@ -1,8 +1,11 @@
|
|||||||
---
|
---
|
||||||
environment: hidden
|
environment: hidden
|
||||||
repositories:
|
repositories:
|
||||||
|
- environment: internal
|
||||||
|
repo: docs/blueprints
|
||||||
|
type: gitea
|
||||||
- environment: public
|
- environment: public
|
||||||
repo: opentelekomcloud-blueprints/docs
|
repo: opentelekomcloud-docs/blueprints
|
||||||
type: github
|
type: github
|
||||||
service_category: other
|
service_category: other
|
||||||
service_title: Blueprints
|
service_title: Blueprints
|
||||||
|
13
otc_metadata/data/services/cc.yaml
Normal file
13
otc_metadata/data/services/cc.yaml
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
environment: public
|
||||||
|
repositories:
|
||||||
|
- environment: public
|
||||||
|
repo: opentelekomcloud-docs/cloud-create
|
||||||
|
type: github
|
||||||
|
service_category: md
|
||||||
|
service_title: Cloud Create
|
||||||
|
service_type: cc
|
||||||
|
service_uri: cloud-create
|
||||||
|
teams:
|
||||||
|
- name: topology-designer-rw
|
||||||
|
permission: write
|
16
otc_metadata/data/services/ocr.yaml
Normal file
16
otc_metadata/data/services/ocr.yaml
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
environment: internal
|
||||||
|
repositories:
|
||||||
|
- environment: internal
|
||||||
|
repo: docs/optical-character-recognition
|
||||||
|
type: gitea
|
||||||
|
- environment: public
|
||||||
|
repo: opentelekomcloud-docs/optical-character-recognition
|
||||||
|
type: github
|
||||||
|
service_category: big_data
|
||||||
|
service_title: Optical Character Recognition
|
||||||
|
service_type: ocr
|
||||||
|
service_uri: optical-character-recognition
|
||||||
|
teams:
|
||||||
|
- name: docs-bigdata-ai-rw
|
||||||
|
permission: write
|
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
environment: public
|
|
||||||
repositories:
|
|
||||||
- environment: internal
|
|
||||||
repo: docs/resource-template-service
|
|
||||||
type: gitea
|
|
||||||
- environment: public
|
|
||||||
repo: opentelekomcloud-docs/resource-template-service
|
|
||||||
type: github
|
|
||||||
service_category: md
|
|
||||||
service_title: Resource Template Service
|
|
||||||
service_type: rts
|
|
||||||
service_uri: resource-template-service
|
|
||||||
teams:
|
|
||||||
- name: docs-orchestration-rw
|
|
||||||
permission: write
|
|
@ -10,7 +10,7 @@ repositories:
|
|||||||
service_category: other
|
service_category: other
|
||||||
service_title: Status Dashboard
|
service_title: Status Dashboard
|
||||||
service_type: sd
|
service_type: sd
|
||||||
service_uri: status-dashboard/umn
|
service_uri: status-dashboard
|
||||||
teams:
|
teams:
|
||||||
- name: docs-eco-rw
|
- name: docs-eco-rw
|
||||||
permission: write
|
permission: write
|
||||||
|
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
environment: hidden
|
|
||||||
repositories:
|
|
||||||
- environment: public
|
|
||||||
repo: opentelekomcloud-docs/telekom-cloud-create
|
|
||||||
type: github
|
|
||||||
service_category: other
|
|
||||||
service_title: Telekom Cloud Create
|
|
||||||
service_type: tcc
|
|
||||||
service_uri: telekom-cloud-create
|
|
||||||
teams:
|
|
||||||
- name: topology-designer-rw
|
|
||||||
permission: write
|
|
@ -1,6 +1,6 @@
|
|||||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
{% if target_environment == 'public' %}
|
{% if target_environment == 'public' %}
|
||||||
otcdocstheme<1.0.0 # Apache-2.0
|
otcdocstheme<2.0.0 # Apache-2.0
|
||||||
{% elif target_environment == 'internal' %}
|
{% elif target_environment == 'internal' %}
|
||||||
otcdocstheme # Apache-2.0
|
otcdocstheme # Apache-2.0
|
||||||
{% else %}
|
{% else %}
|
||||||
@ -11,4 +11,5 @@ reno>=3.1.0 # Apache-2.0
|
|||||||
|
|
||||||
otc-sphinx-directives>=0.1.0
|
otc-sphinx-directives>=0.1.0
|
||||||
sphinx-minify>=0.0.1 # Apache-2.0
|
sphinx-minify>=0.0.1 # Apache-2.0
|
||||||
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
|
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
|
||||||
|
setuptools
|
@ -43,15 +43,19 @@ commands =
|
|||||||
{%- endfor %}
|
{%- endfor %}
|
||||||
|
|
||||||
[testenv:docs-pdf]
|
[testenv:docs-pdf]
|
||||||
deps = {[testenv:docs]deps}
|
deps =
|
||||||
|
{[testenv:docs]deps}
|
||||||
|
{[testenv:bindeps]deps}
|
||||||
allowlist_externals =
|
allowlist_externals =
|
||||||
rm
|
rm
|
||||||
mkdir
|
mkdir
|
||||||
|
wget
|
||||||
make
|
make
|
||||||
bash
|
bash
|
||||||
cp
|
cp
|
||||||
commands =
|
commands =
|
||||||
mkdir -p doc/build/pdf
|
mkdir -p doc/build/pdf
|
||||||
|
{[testenv:bindeps]commands}
|
||||||
{%- for doc in docs %}
|
{%- for doc in docs %}
|
||||||
{%- if doc.pdf_name %}
|
{%- if doc.pdf_name %}
|
||||||
{[testenv:{{ doc.type }}-pdf-docs]commands}
|
{[testenv:{{ doc.type }}-pdf-docs]commands}
|
||||||
@ -118,6 +122,21 @@ commands =
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
||||||
|
[testenv:bindeps]
|
||||||
|
deps =
|
||||||
|
bindep
|
||||||
|
allowlist_externals =
|
||||||
|
wget
|
||||||
|
rm
|
||||||
|
bash
|
||||||
|
commands =
|
||||||
|
rm -rf {toxinidir}/bindep.txt
|
||||||
|
rm -rf {toxinidir}/packages.txt
|
||||||
|
wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
|
||||||
|
bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
|
||||||
|
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
|
||||||
|
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
|
||||||
|
|
||||||
[doc8]
|
[doc8]
|
||||||
ignore = D001
|
ignore = D001
|
||||||
extensions = .rst, .yaml
|
extensions = .rst, .yaml
|
12
otc_metadata/templates/zuul.yaml.j2
Normal file
12
otc_metadata/templates/zuul.yaml.j2
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
- project:
|
||||||
|
merge-mode: squash-merge
|
||||||
|
default-branch: main
|
||||||
|
templates:
|
||||||
|
- helpcenter-base-jobs
|
||||||
|
check:
|
||||||
|
jobs:
|
||||||
|
- noop
|
||||||
|
gate:
|
||||||
|
jobs:
|
||||||
|
- noop
|
@ -50,6 +50,7 @@ def process_repositories(args, service):
|
|||||||
)
|
)
|
||||||
conf_py_template = env.get_template("conf.py.j2")
|
conf_py_template = env.get_template("conf.py.j2")
|
||||||
tox_ini_template = env.get_template("tox.ini.j2")
|
tox_ini_template = env.get_template("tox.ini.j2")
|
||||||
|
zuul_yaml_template = env.get_template("zuul.yaml.j2")
|
||||||
index_sbv_template = env.get_template("index_sbv.rst.j2")
|
index_sbv_template = env.get_template("index_sbv.rst.j2")
|
||||||
doc_requirements_template = env.get_template("doc_requirements.txt.j2")
|
doc_requirements_template = env.get_template("doc_requirements.txt.j2")
|
||||||
|
|
||||||
@ -259,6 +260,16 @@ def process_repositories(args, service):
|
|||||||
out.write(doc_requirements_content)
|
out.write(doc_requirements_content)
|
||||||
repo_to.index.add(["doc/requirements.txt"])
|
repo_to.index.add(["doc/requirements.txt"])
|
||||||
|
|
||||||
|
if args.update_zuul:
|
||||||
|
"""Update zuul.yaml"""
|
||||||
|
|
||||||
|
zuul_yaml_content = zuul_yaml_template.render(**context)
|
||||||
|
zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")
|
||||||
|
with open(zuul_yaml_path, "w", encoding="utf-8", newline="") as out:
|
||||||
|
logging.debug(f"Generating {zuul_yaml_path} from template...")
|
||||||
|
out.write(zuul_yaml_content)
|
||||||
|
repo_to.index.add(["zuul.yaml"])
|
||||||
|
|
||||||
if len(repo_to.index.diff("HEAD")) == 0:
|
if len(repo_to.index.diff("HEAD")) == 0:
|
||||||
# Nothing to commit
|
# Nothing to commit
|
||||||
logging.debug(
|
logging.debug(
|
||||||
@ -344,6 +355,11 @@ def main():
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="Whether to update service-based-view"
|
help="Whether to update service-based-view"
|
||||||
)
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--update-zuul",
|
||||||
|
action="store_true",
|
||||||
|
help="Whether to update zuul.yaml"
|
||||||
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--overwrite-index-sbv",
|
"--overwrite-index-sbv",
|
||||||
action="store_true",
|
action="store_true",
|
||||||
|
Reference in New Issue
Block a user