Compare commits
17 Commits
cc_apiref
...
hidden_rae
Author | SHA1 | Date | |
---|---|---|---|
5b293f120d | |||
cd6241bef5 | |||
cb2e4bd9d4 | |||
5b23c77309 | |||
c1c45ec37d | |||
e0b234d46f | |||
762eac98a6 | |||
f11e3fc8fc | |||
ef7985a733 | |||
28a1c05d34 | |||
1d8f91ff0b | |||
efecf2237d | |||
ba4d942a1e | |||
bda2e6aa21 | |||
b9d235abc0 | |||
f06f533823 | |||
b4290744e3 |
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
|
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
|
@ -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,9 +0,0 @@
|
|||||||
---
|
|
||||||
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
|
|
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,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
environment: hidden
|
environment: public
|
||||||
repositories:
|
repositories:
|
||||||
- environment: public
|
- environment: public
|
||||||
repo: opentelekomcloud-docs/cloud-create
|
repo: opentelekomcloud-docs/cloud-create
|
||||||
type: github
|
type: github
|
||||||
service_category: other
|
service_category: md
|
||||||
service_title: Cloud Create
|
service_title: Cloud Create
|
||||||
service_type: cc
|
service_type: cc
|
||||||
service_uri: cloud-create
|
service_uri: cloud-create
|
||||||
|
13
otc_metadata/data/services/dod.yaml
Normal file
13
otc_metadata/data/services/dod.yaml
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
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
|
16
otc_metadata/data/services/gloss.yaml
Normal file
16
otc_metadata/data/services/gloss.yaml
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
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
|
13
otc_metadata/data/services/intdocs.yaml
Normal file
13
otc_metadata/data/services/intdocs.yaml
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
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
|
16
otc_metadata/data/services/rae.yaml
Normal file
16
otc_metadata/data/services/rae.yaml
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
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
|
@ -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
|
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
environment: hidden
|
environment: public
|
||||||
repositories:
|
repositories:
|
||||||
- environment: internal
|
- environment: internal
|
||||||
repo: docs/status-dashboard
|
repo: docs/status-dashboard
|
||||||
|
16
otc_metadata/data/services/sec.yaml
Normal file
16
otc_metadata/data/services/sec.yaml
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
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
|
@ -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 %}
|
||||||
|
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