Compare commits
2 Commits
enable_css
...
fix_otc_do
Author | SHA1 | Date | |
---|---|---|---|
b1bf66f027 | |||
5dc8684126 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -59,6 +59,3 @@ ChangeLog
|
|||||||
|
|
||||||
# Files created by releasenotes build
|
# Files created by releasenotes build
|
||||||
releasenotes/build
|
releasenotes/build
|
||||||
|
|
||||||
bindep.txt
|
|
||||||
packages.txt
|
|
@ -1,8 +0,0 @@
|
|||||||
---
|
|
||||||
environment: public
|
|
||||||
link: /architecture-center/blueprints/
|
|
||||||
pdf_name: architecture-center-blueprints
|
|
||||||
rst_location: doc/blueprints/source
|
|
||||||
service_type: ac
|
|
||||||
title: Blueprints
|
|
||||||
type: blueprints
|
|
@ -1,8 +0,0 @@
|
|||||||
---
|
|
||||||
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,6 +0,0 @@
|
|||||||
---
|
|
||||||
link: /business-dashboard/umn/
|
|
||||||
rst_location: umn/source
|
|
||||||
service_type: bd
|
|
||||||
title: User Guide
|
|
||||||
type: umn
|
|
@ -1,8 +0,0 @@
|
|||||||
---
|
|
||||||
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
|
|
@ -1,8 +0,0 @@
|
|||||||
---
|
|
||||||
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
|
|
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
hc_location: bestpractice/css
|
hc_location: bestpractice/css
|
||||||
|
environment: internal
|
||||||
html_location: docs/css/best-practice
|
html_location: docs/css/best-practice
|
||||||
link: /cloud-search-service/best-practice/
|
link: /cloud-search-service/best-practice/
|
||||||
pdf_name: css-best-practice
|
pdf_name: css-best-practice
|
||||||
|
9
otc_metadata/data/documents/rts-api-ref.yaml
Normal file
9
otc_metadata/data/documents/rts-api-ref.yaml
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
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
|
9
otc_metadata/data/documents/rts-umn.yaml
Normal file
9
otc_metadata/data/documents/rts-umn.yaml
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
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
|
9
otc_metadata/data/documents/sd-umn.yaml
Normal file
9
otc_metadata/data/documents/sd-umn.yaml
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
hc_location: usermanual/sd
|
||||||
|
html_location: docs/sd/umn
|
||||||
|
link: /status-dashboard/umn/
|
||||||
|
pdf_name: sd-umn
|
||||||
|
rst_location: umn/source
|
||||||
|
service_type: sd
|
||||||
|
title: User Guide
|
||||||
|
type: umn
|
8
otc_metadata/data/documents/tcc-umn.yaml
Normal file
8
otc_metadata/data/documents/tcc-umn.yaml
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
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
|
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
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: internal
|
environment: public
|
||||||
repositories:
|
repositories:
|
||||||
- environment: internal
|
- environment: internal
|
||||||
repo: docs/api-usage
|
repo: docs/api-usage
|
||||||
|
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
environment: internal
|
|
||||||
repositories:
|
|
||||||
- environment: internal
|
|
||||||
repo: docs/business-dashboard
|
|
||||||
type: gitea
|
|
||||||
service_category: other
|
|
||||||
service_title: Business Dashboard
|
|
||||||
service_type: bd
|
|
||||||
service_uri: business-dashboard
|
|
||||||
teams:
|
|
||||||
- name: docs-dashboard-rw
|
|
||||||
permission: write
|
|
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
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
|
|
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
environment: hidden
|
|
||||||
repositories:
|
|
||||||
- environment: public
|
|
||||||
repo: opentelekomcloud-docs/docs_on_docs
|
|
||||||
type: github
|
|
||||||
service_category: other
|
|
||||||
service_title: Documentation about documentation
|
|
||||||
service_type: dod
|
|
||||||
service_uri: docs-on-docs
|
|
||||||
teams:
|
|
||||||
- name: docs-eco-rw
|
|
||||||
permission: write
|
|
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
environment: hidden
|
|
||||||
repositories:
|
|
||||||
- environment: internal
|
|
||||||
repo: docs/glossary
|
|
||||||
type: gitea
|
|
||||||
- environment: public
|
|
||||||
repo: opentelekomcloud-docs/glossary
|
|
||||||
type: github
|
|
||||||
service_category: other
|
|
||||||
service_title: Glossary
|
|
||||||
service_type: gloss
|
|
||||||
service_uri: glossary
|
|
||||||
teams:
|
|
||||||
- name: docs-eco-rw
|
|
||||||
permission: write
|
|
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
environment: internal
|
|
||||||
repositories:
|
|
||||||
- environment: internal
|
|
||||||
repo: docs/internal-documentation
|
|
||||||
type: gitea
|
|
||||||
service_category: other
|
|
||||||
service_title: Internal Documentation
|
|
||||||
service_type: intdocs
|
|
||||||
service_uri: internal-documentation
|
|
||||||
teams:
|
|
||||||
- name: docs-eco-rw
|
|
||||||
permission: write
|
|
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
environment: hidden
|
|
||||||
repositories:
|
|
||||||
- environment: internal
|
|
||||||
repo: docs/regions-and-endpoints
|
|
||||||
type: gitea
|
|
||||||
- environment: public
|
|
||||||
repo: opentelekomcloud-docs/regions-and-endpoints
|
|
||||||
type: github
|
|
||||||
service_category: other
|
|
||||||
service_title: Regions and Endpoints
|
|
||||||
service_type: rae
|
|
||||||
service_uri: regions-and-endpoints
|
|
||||||
teams:
|
|
||||||
- name: docs-eco-rw
|
|
||||||
permission: write
|
|
16
otc_metadata/data/services/rts.yaml
Normal file
16
otc_metadata/data/services/rts.yaml
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
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
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
environment: public
|
environment: hidden
|
||||||
repositories:
|
repositories:
|
||||||
- environment: internal
|
- environment: internal
|
||||||
repo: docs/status-dashboard
|
repo: docs/status-dashboard
|
||||||
@ -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
|
service_uri: status-dashboard/umn
|
||||||
teams:
|
teams:
|
||||||
- name: docs-eco-rw
|
- name: docs-eco-rw
|
||||||
permission: write
|
permission: write
|
||||||
|
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
environment: hidden
|
|
||||||
repositories:
|
|
||||||
- environment: internal
|
|
||||||
repo: docs/security
|
|
||||||
type: gitea
|
|
||||||
- environment: public
|
|
||||||
repo: opentelekomcloud-docs/security
|
|
||||||
type: github
|
|
||||||
service_category: other
|
|
||||||
service_title: Security
|
|
||||||
service_type: sec
|
|
||||||
service_uri: security
|
|
||||||
teams:
|
|
||||||
- name: docs-eco-rw
|
|
||||||
permission: write
|
|
13
otc_metadata/data/services/tcc.yaml
Normal file
13
otc_metadata/data/services/tcc.yaml
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
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
|
@ -38,14 +38,14 @@ otcdocs_git_type = '{{ git_type }}'
|
|||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
# Those variables are needed for indexing into OpenSearch
|
# Those variables are needed for indexing into OpenSearch
|
||||||
otcdocs_doc_environment = '{{ doc_environment }}'
|
otcdocs_doc_environment = "{{ doc_environment }}"
|
||||||
otcdocs_doc_link = '{{ doc_link }}'
|
otcdocs_doc_link = "{{ doc_link }}"
|
||||||
otcdocs_doc_title = '{{ doc_title }}'
|
otcdocs_doc_title = "{{ doc_title }}"
|
||||||
otcdocs_doc_type = '{{ doc_type }}'
|
otcdocs_doc_type = "{{ doc_type }}"
|
||||||
otcdocs_service_category = '{{ service_category }}'
|
otcdocs_service_category = "{{ service_category }}"
|
||||||
otcdocs_service_title = '{{ service_title }}'
|
otcdocs_service_title = "{{ service_title }}"
|
||||||
otcdocs_service_type = '{{ service_type }}'
|
otcdocs_service_type = "{{ service_type }}"
|
||||||
otcdocs_search_environment = 'hc_de'
|
otcdocs_search_environment = "hc_de"
|
||||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
@ -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<2.0.0 # Apache-2.0
|
otcdocstheme<1.0.0 # Apache-2.0
|
||||||
{% elif target_environment == 'internal' %}
|
{% elif target_environment == 'internal' %}
|
||||||
otcdocstheme # Apache-2.0
|
otcdocstheme # Apache-2.0
|
||||||
{% else %}
|
{% else %}
|
||||||
@ -11,5 +11,4 @@ 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
|
|
@ -13,8 +13,6 @@ commands = stestr run {posargs}
|
|||||||
stestr slowest
|
stestr slowest
|
||||||
|
|
||||||
[testenv:pep8]
|
[testenv:pep8]
|
||||||
allowlist_externals =
|
|
||||||
doc8
|
|
||||||
commands =
|
commands =
|
||||||
doc8 doc/source README.rst
|
doc8 doc/source README.rst
|
||||||
|
|
||||||
@ -45,19 +43,15 @@ commands =
|
|||||||
{%- endfor %}
|
{%- endfor %}
|
||||||
|
|
||||||
[testenv:docs-pdf]
|
[testenv:docs-pdf]
|
||||||
deps =
|
deps = {[testenv:docs]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}
|
||||||
@ -124,21 +118,6 @@ 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
|
@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
- project:
|
|
||||||
merge-mode: squash-merge
|
|
||||||
default-branch: main
|
|
||||||
templates:
|
|
||||||
- helpcenter-base-jobs
|
|
||||||
check:
|
|
||||||
jobs:
|
|
||||||
- noop
|
|
||||||
gate:
|
|
||||||
jobs:
|
|
||||||
- noop
|
|
@ -50,7 +50,6 @@ 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")
|
||||||
|
|
||||||
@ -260,16 +259,6 @@ 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(
|
||||||
@ -355,11 +344,6 @@ 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