Compare commits

...

18 Commits

Author SHA1 Message Date
6e631d7dff fix pep8 template in tox.ini
All checks were successful
gl/check check status: success (6e631d7dff80229f4e5c7236b3a54e7d1903dc0e)
gl/gate gate status: success (6e631d7dff80229f4e5c7236b3a54e7d1903dc0e)
2024-02-20 15:26:55 +00:00
adc0cb82c3 make glossary, security, regions and endpoints hidden
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-02-14 11:34:15 +00:00
cd6241bef5 add Glossary and Security Advisory
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-02-13 14:29:34 +00:00
cb2e4bd9d4 add new repo regions and Endpoints rae
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-02-13 14:25:04 +00:00
5b23c77309 make sd public available
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-02-13 14:12:33 +00:00
c1c45ec37d make status dashboard documentation visible and remove umn
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-02-13 10:59:24 +00:00
e0b234d46f add gitea repo for Internal documentation
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-02-13 09:50:44 +00:00
762eac98a6 added docs-on-docs
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2024-02-12 09:14:31 +00:00
f11e3fc8fc fix link for caf
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-31 09:35:12 +00:00
ef7985a733 Increase otcdocstheme public version requirement
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2024-01-29 10:26:20 +00:00
28a1c05d34 fixing AC docs locations and titles
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2024-01-26 08:54:50 +00:00
1d8f91ff0b add internal repo for AC
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-25 11:14:43 +00:00
efecf2237d init architecture center
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-25 09:43:33 +00:00
ba4d942a1e Change visibility of API Usage to internal
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-24 13:45:13 +00:00
bda2e6aa21 teardown rts
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-24 08:57:34 +00:00
b9d235abc0 add Cloud Create to Management and Deployment
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-17 14:53:24 +00:00
f06f533823 add api-ref documentation to Cloud Create
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-17 14:24:33 +00:00
b4290744e3 zuulyaml update script
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2024-01-17 14:06:30 +00:00
20 changed files with 149 additions and 48 deletions

View 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

View File

@ -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

View 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

View File

@ -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

View File

@ -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

View File

@ -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

View 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

View File

@ -1,5 +1,5 @@
---
environment: public
environment: internal
repositories:
- environment: internal
repo: docs/api-usage

View File

@ -1,10 +1,10 @@
---
environment: hidden
environment: public
repositories:
- environment: public
repo: opentelekomcloud-docs/cloud-create
type: github
service_category: other
service_category: md
service_title: Cloud Create
service_type: cc
service_uri: cloud-create

View 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

View 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

View 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

View 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

View File

@ -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

View File

@ -1,5 +1,5 @@
---
environment: hidden
environment: public
repositories:
- environment: internal
repo: docs/status-dashboard

View 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

View File

@ -1,6 +1,6 @@
sphinx>=2.0.0,!=2.1.0 # BSD
{% if target_environment == 'public' %}
otcdocstheme<1.0.0 # Apache-2.0
otcdocstheme<2.0.0 # Apache-2.0
{% elif target_environment == 'internal' %}
otcdocstheme # Apache-2.0
{% else %}

View File

@ -13,6 +13,8 @@ commands = stestr run {posargs}
stestr slowest
[testenv:pep8]
allowlist_externals =
doc8
commands =
doc8 doc/source README.rst

View File

@ -0,0 +1,12 @@
---
- project:
merge-mode: squash-merge
default-branch: main
templates:
- helpcenter-base-jobs
check:
jobs:
- noop
gate:
jobs:
- noop

View File

@ -50,6 +50,7 @@ def process_repositories(args, service):
)
conf_py_template = env.get_template("conf.py.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")
doc_requirements_template = env.get_template("doc_requirements.txt.j2")
@ -259,6 +260,16 @@ def process_repositories(args, service):
out.write(doc_requirements_content)
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:
# Nothing to commit
logging.debug(
@ -344,6 +355,11 @@ def main():
action="store_true",
help="Whether to update service-based-view"
)
parser.add_argument(
"--update-zuul",
action="store_true",
help="Whether to update zuul.yaml"
)
parser.add_argument(
"--overwrite-index-sbv",
action="store_true",