adding new best pratice metadata

.gitignore

@@ -59,6 +59,3 @@ ChangeLog
 
 # Files created by releasenotes build
 releasenotes/build
-
-bindep.txt
-packages.txt

otc_metadata/data/documents/ac-blueprints.yaml

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

otc_metadata/data/documents/ac-cloud-adoption-framework.yaml

@@ -1,8 +0,0 @@
----
-environment: internal
-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

otc_metadata/data/documents/aom-umn2.yaml

@@ -1,10 +0,0 @@
----
-environment: internal
-hc_location: usermanual2/aom
-html_location: docs/aom/umn2
-link: /application-operations-management/umn2/
-pdf_name: aom-umn2.0
-rst_location: umn2/source
-service_type: aom
-title: User Guide 2.0
-type: umn2

otc_metadata/data/documents/apiu-guidelines.yaml

@@ -1,10 +0,0 @@
----
-environment: internal
-hc_location: api-usage/guidelines
-html_location: docs/apiu/guidelines
-link: /api-usage/guidelines/
-pdf_name: apiu-guidelines
-rst_location: doc/guidelines/source
-service_type: apiu
-title: API Usage Guidelines
-type: guidelines

otc_metadata/data/documents/bd-umn.yaml

@@ -1,6 +0,0 @@
----
-link: /business-dashboard/umn/
-rst_location: umn/source
-service_type: bd
-title: User Guide
-type: umn

otc_metadata/data/documents/blueprints-best-practice.yaml

@@ -1,10 +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

otc_metadata/data/documents/cc-api-ref.yaml

@@ -1,7 +0,0 @@
----
-link: /cloud-create/api-ref/
-pdf_name: cc-api-ref
-rst_location: api-ref/source
-service_type: cc
-title: API Reference
-type: api-ref

otc_metadata/data/documents/cc-umn.yaml

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

otc_metadata/data/documents/css-best-practice.yaml

@@ -1,5 +1,6 @@
 ---
 hc_location: bestpractice/css
+environment: internal
 html_location: docs/css/best-practice
 link: /cloud-search-service/best-practice/
 pdf_name: css-best-practice

otc_metadata/data/documents/dli-dev.yaml

@@ -1,10 +0,0 @@
----
-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

otc_metadata/data/documents/dli-sqlreference.yaml

@@ -1,9 +0,0 @@
----
-hc_location: sqlreference/dli
-html_location: docs/dli/sqlreference
-link: /data-lake-insight/sqlreference/
-pdf_name: dli-sqlreference
-rst_location: doc/sqlreference/source
-service_type: dli
-title: Sql Syntax Reference
-type: sqlreference

otc_metadata/data/documents/drs-best-practice.yaml

@@ -1,10 +0,0 @@
----
-hc_location: bestpractice/drs
-environment: internal
-html_location: docs/drs/best-practice
-link: /data-replication-service/best-practice/
-pdf_name: drs-best-practice
-rst_location: doc/best-practice/source
-service_type: drs
-title: Best Practice
-type: best-practice

otc_metadata/data/documents/fg-api-ref.yaml

@@ -1,5 +1,6 @@
 ---
 hc_location: api/functiongraph
+environment: internal
 html_location: docs/fg/api-ref
 link: /function-graph/api-ref/
 pdf_name: fg-api-ref

otc_metadata/data/documents/fg-umn.yaml

@@ -1,5 +1,6 @@
 ---
 hc_location: usermanual/functiongraph
+environment: internal
 html_location: docs/fg/umn
 link: /function-graph/umn/
 pdf_name: fg-umn

otc_metadata/data/documents/gaussdb_nosql-api-ref.yaml

@@ -1,5 +1,6 @@
 ---
 hc_location: api/nosql
+environment: internal
 html_location: docs/gaussdb_nosql/api-ref
 link: /gaussdb-nosql/api-ref/
 pdf_name: gaussdb_nosql-api-ref

otc_metadata/data/documents/gaussdb_nosql-umn.yaml

@@ -1,4 +1,5 @@
 ---
+environment: internal
 hc_location: usermanual/nosql
 html_location: docs/gaussdb_nosql/umn
 link: /gaussdb-nosql/umn/

otc_metadata/data/documents/hss-umn.yaml

@@ -1,6 +1,7 @@
 ---
 hc_location: usermanual/hss2.0
 environment: internal
+hc_location: usermanual/nosql
 html_location: docs/hss/umn
 link: /host-security-service/umn/
 pdf_name: hss-umn

otc_metadata/data/documents/ims-best-practice.yaml

@@ -1,10 +0,0 @@
----
-hc_location: bestpractice/ims
-environment: internal
-html_location: docs/ims/best-practice
-link: /image-management-service/best-practice/
-pdf_name: ims-best-practice
-rst_location: doc/best-practice/source
-service_type: ims
-title: Best Practice
-type: best-practice

otc_metadata/data/documents/ocr-api-ref.yaml

@@ -1,9 +0,0 @@
----
-hc_location: api/ocr
-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

otc_metadata/data/documents/ocr-umn.yaml

@@ -1,9 +0,0 @@
----
-hc_location: usermanual/ocr
-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

otc_metadata/data/documents/rts-api-ref.yaml

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

otc_metadata/data/documents/rts-umn.yaml

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

otc_metadata/data/documents/sd-umn.yaml

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

otc_metadata/data/documents/tcc-umn.yaml

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

otc_metadata/data/service_categories/database.yaml

@@ -1,3 +1,3 @@
 ---
 name: database
-title: Databases
+title: Database

otc_metadata/data/services/ac.yaml

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

otc_metadata/data/services/apiu.yaml

@@ -1,16 +0,0 @@
----
-environment: internal
-repositories:
-- environment: internal
-  repo: docs/api-usage
-  type: gitea
-- environment: public
-  repo: opentelekomcloud-docs/api-usage
-  type: github
-service_category: other
-service_title: API Usage
-service_type: apiu
-service_uri: api-usage
-teams:
-- name: eco
-  permission: write

otc_metadata/data/services/bd.yaml

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

otc_metadata/data/services/blueprints.yaml

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

otc_metadata/data/services/cc.yaml

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

otc_metadata/data/services/dod.yaml

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

otc_metadata/data/services/fg.yaml

@@ -1,5 +1,5 @@
 ---
-environment: public
+environment: internal
 repositories:
 - environment: internal
   repo: docs/function-graph
@@ -12,5 +12,5 @@ service_title: FunctionGraph
 service_type: fg
 service_uri: function-graph
 teams:
-- name: docs-container-rw
+- name: docs-compute-rw
   permission: write

otc_metadata/data/services/gloss.yaml

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

otc_metadata/data/services/intdocs.yaml

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

otc_metadata/data/services/ocr.yaml

@@ -1,16 +0,0 @@
----
-environment: public
-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

otc_metadata/data/services/rae.yaml

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

otc_metadata/data/services/rts.yaml

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

otc_metadata/data/services/sd.yaml

@@ -1,5 +1,5 @@
 ---
-environment: public
+environment: hidden
 repositories:
 - environment: internal
   repo: docs/status-dashboard
@@ -10,7 +10,7 @@ repositories:
 service_category: other
 service_title: Status Dashboard
 service_type: sd
-service_uri: status-dashboard
+service_uri: status-dashboard/umn
 teams:
 - name: docs-eco-rw
   permission: write

otc_metadata/data/services/sec.yaml

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

otc_metadata/data/services/tcc.yaml

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

otc_metadata/services.py

@@ -246,19 +246,12 @@ class Services(object):
                     x for x in srv["teams"] if x["permission"] == "write"
                 ]
             if "repositories" in srv and environment:
-                internal_exists = False
                 for repo in srv["repositories"]:
                     if (
                         "environment" in repo
                         and repo["environment"] == environment
                     ):
                         srv_res["repository"] = repo["repo"]
-                        if repo["environment"] == "internal":
-                            internal_exists = True
-                # internal repo does not exist
-                # service will be left out from metadata.yaml
-                if not internal_exists:
-                    continue
             for doc in self.all_docs:
                 if (
                     "html_location" in doc

otc_metadata/templates/doc_requirements.txt.j2

@@ -1,15 +1,7 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
-{% if target_environment == 'public' %}
-otcdocstheme<2.0.0 # Apache-2.0
-{% elif target_environment == 'internal' %}
 otcdocstheme # Apache-2.0
-{% else %}
-otcdocstheme # Apache-2.0
-{% endif %}
 # releasenotes
 reno>=3.1.0 # Apache-2.0
 
 otc-sphinx-directives>=0.1.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
-setuptools
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

otc_metadata/templates/zuul.yaml.j2

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

tools/generate_doc_confpy.py

@@ -50,7 +50,6 @@ 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")
 
@@ -238,8 +237,6 @@ def process_repositories(args, service):
                 doc["type"] = "dev-guide"
             context["docs"].append(doc)
 
-        context["target_environment"] = args.target_environment
-
         tox_ini_content = tox_ini_template.render(**context)
         tox_ini_path = pathlib.Path(copy_to, "tox.ini")
         doc_requirements_content = doc_requirements_template.render(**context)
@@ -260,16 +257,6 @@ 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(
@@ -326,7 +313,6 @@ def main():
     parser.add_argument(
         "--target-environment",
         required=True,
-        choices=["internal", "public"],
         help="Environment to be used as a source",
     )
     parser.add_argument("--service-type", help="Service to update")
@@ -355,11 +341,6 @@ 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",

tools/sync_doc_repo.py

@@ -95,12 +95,12 @@ def process_repositories(args, service):
                 f"due to the doc-type filter."
             )
             continue
-        # if doc.get("environment"):
-        #     logging.info(
-        #         f"Skipping synchronizing {doc['title']} "
-        #         f"since it is environment bound."
-        #     )
-        #     continue
+        if doc.get("environment"):
+            logging.info(
+                f"Skipping synchronizing {doc['title']} "
+                f"since it is environment bound."
+            )
+            continue
 
         branch_name = f"{args.branch_name}#{doc['type']}"
         remote_ref = SymbolicReference.create(