add api-ref for dbss

Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>

otc_metadata/data/documents/ac-blueprints.yaml

@@ -1,9 +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
-disable_import: true

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

@@ -1,9 +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
-disable_import: true

otc_metadata/data/documents/asm-umn.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 hc_location: usermanual/asm
 html_location: docs/asm/umn
 link: /application-service-mesh/umn/

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

@@ -1,11 +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
-disable_import: true

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

@@ -1,6 +1,6 @@
 ---
 hc_location: api/cci
-environment: internal
+environment: public
 html_location: docs/cci/api-ref
 link: /cloud-container-instance/api-ref/
 pdf_name: cci-api-ref

otc_metadata/data/documents/cci-umn.yaml

@@ -1,6 +1,6 @@
 ---
 hc_location: usermanual/cci
-environment: internal
+environment: public
 html_location: docs/cci/umn
 link: /cloud-container-instance/umn/
 pdf_name: cci-umn

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

@@ -1,5 +1,4 @@
 ---
-environment: internal
 hc_location: api/rms
 html_location: docs/config/api-ref
 link: /config/api-ref/

otc_metadata/data/documents/config-umn.yaml

@@ -1,5 +1,4 @@
 ---
-environment: internal
 hc_location: usermanual/rms
 html_location: docs/config/umn
 link: /config/umn/

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

@@ -0,0 +1,9 @@
+---
+hc_location: api/dbss
+html_location: docs/dbss/api-ref
+link: /database-security-service/api-ref/
+pdf_name: dbss-api-ref
+rst_location: api-ref/source
+service_type: dbss
+title: API Reference
+type: api-ref

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

@@ -0,0 +1,11 @@
+---
+environment: internal
+hc_location: api/em
+html_location: docs/eps/api-ref
+link: /enterprise-project-service/api-ref/
+pdf_name: eps-api-ref
+rst_location: api-ref/source
+service_type: eps
+title: API Reference
+type: api-ref
+

otc_metadata/data/documents/eps-umn.yaml

@@ -0,0 +1,11 @@
+---
+environment: internal
+hc_location: usermanual/em
+html_location: docs/eps/umn
+link: /enterprise-project-service/umn/
+pdf_name: eps-umn
+rst_location: umn/source
+service_type: eps
+title: User Guide
+type: umn
+

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

@@ -1,9 +0,0 @@
----
-hc_location: api/nosql
-html_location: docs/gaussdb_nosql/api-ref
-link: /gaussdb-nosql/api-ref/
-pdf_name: gaussdb_nosql-api-ref
-rst_location: api-ref/source
-service_type: gaussdb_nosql
-title: API Reference
-type: api-ref

otc_metadata/data/documents/gaussdb_nosql-umn.yaml

@@ -1,9 +0,0 @@
----
-hc_location: usermanual/nosql
-html_location: docs/gaussdb_nosql/umn
-link: /gaussdb-nosql/umn/
-pdf_name: gauss_nosql
-rst_location: umn/source
-service_type: gaussdb_nosql
-title: User Guide
-type: umn

otc_metadata/data/documents/iam-mycredential.yaml

@@ -6,3 +6,4 @@ rst_location: doc/mycredential/source
 service_type: iam
 title: My Credential
 type: mycredential
+disable_import: true

otc_metadata/data/documents/obs-swiftapi.yaml

@@ -1,9 +0,0 @@
----
-hc_location: api_swift/obs
-html_location: docs/obs/api-swift
-link: /object-storage-service/swiftapi/
-pdf_name: obs-swiftapi
-rst_location: doc/swiftapi/source
-service_type: obs
-title: API Reference (Swift) - Deprecated - Will be removed at 2023 Nov. 10!
-type: swiftapi

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

@@ -0,0 +1,10 @@
+---
+hc_location: api/aos
+environment: internal
+html_location: docs/rfs/api-ref
+link: /resource-formation-service/api-ref/
+pdf_name: rfs-api-ref
+rst_location: api-ref/source
+service_type: rfs
+title: API Reference
+type: api-ref

otc_metadata/data/documents/rfs-umn.yaml

@@ -0,0 +1,10 @@
+---
+hc_location: usermanual/aos
+environment: internal
+html_location: docs/rfs/umn
+link: /resource-formation-service/umn/
+pdf_name: rfs-umn
+rst_location: umn/source
+service_type: rfs
+title: User Guide
+type: umn

otc_metadata/data/documents/smg-umn.yaml

@@ -6,3 +6,4 @@ rst_location: umn/source
 service_type: smg
 title: User Guide
 type: umn
+disable_import: true

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/aom.yaml

@@ -12,5 +12,5 @@ service_title: Application Operations Management
 service_type: aom
 service_uri: application-operations-management
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/aom2.yaml

@@ -12,5 +12,5 @@ service_title: Application Operations Management 2.0
 service_type: aom2
 service_uri: application-operations-management-2
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/apig.yaml

@@ -12,5 +12,5 @@ service_title: API Gateway (APIG)
 service_type: apig
 service_uri: api-gateway
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/apm.yaml

@@ -7,10 +7,10 @@ repositories:
 - environment: public
   repo: opentelekomcloud-docs/application-performance-management
   type: github
-service_category: md
+service_category: application
 service_title: Application Performance Management
 service_type: apm
 service_uri: application-performance-management
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/asm.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/application-service-mesh

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/cci.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/cloud-container-instance

otc_metadata/data/services/ces.yaml

@@ -12,5 +12,5 @@ service_title: Cloud Eye
 service_type: ces
 service_uri: cloud-eye
 teams:
-- name: docs-orchestration-rw
+- name: docs-cms-rw
   permission: write

otc_metadata/data/services/config.yaml

@@ -1,5 +1,5 @@
 ---
-environment: internal
+environment: public
 repositories:
 - environment: internal
   repo: docs/config
@@ -12,5 +12,5 @@ service_title: Config
 service_type: config
 service_uri: config
 teams:
-- name: docs-orchestration-rw
+- name: docs-cms-rw
   permission: write

otc_metadata/data/services/cse.yaml

@@ -12,5 +12,5 @@ service_title: Cloud Service Engine
 service_type: cse
 service_uri: cloud-service-engine
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/cts.yaml

@@ -12,5 +12,5 @@ service_title: Cloud Trace Service
 service_type: cts
 service_uri: cloud-trace-service
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/dcs.yaml

@@ -12,5 +12,5 @@ service_title: Distributed Cache Service
 service_type: dcs
 service_uri: distributed-cache-service
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/dms.yaml

@@ -12,5 +12,5 @@ service_title: Distributed Message Service
 service_type: dms
 service_uri: distributed-message-service
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/ed.yaml

@@ -1,9 +1,6 @@
 ---
 environment: public
 repositories:
-- environment: internal
-  repo: docs/enterprise-dashboard
-  type: gitea
 - environment: public
   repo: opentelekomcloud-docs/enterprise-dashboard
   type: github

otc_metadata/data/services/eps.yaml

@@ -0,0 +1,17 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/enterprise-project-service
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/enterprise-project-service
+  type: github
+service_category: security-services
+service_title: Enterprise Project Service
+service_type: eps
+service_uri: enterprise-project-service
+teams:
+- name: docs-security-services-rw
+  permission: write
+

otc_metadata/data/services/fg.yaml

@@ -12,5 +12,5 @@ service_title: FunctionGraph
 service_type: fg
 service_uri: function-graph
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/gaussdb_nosql.yaml

@@ -1,16 +0,0 @@
----
-environment: public
-repositories:
-- environment: internal
-  repo: docs/gaussdb-nosql
-  type: gitea
-- environment: public
-  repo: opentelekomcloud-docs/gaussdb-nosql
-  type: github
-service_category: database
-service_title: GaussDB NoSQL
-service_type: gaussdb_nosql
-service_uri: gaussdb-nosql
-teams:
-- name: docs-database-rw
-  permission: write

otc_metadata/data/services/lts.yaml

@@ -12,5 +12,5 @@ service_title: Log Tank Service
 service_type: lts
 service_uri: log-tank-service
 teams:
-- name: docs-orchestration-rw
+- name: docs-paas-rw
   permission: write

otc_metadata/data/services/rfs.yaml

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs/resource-formation-service
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs/resource-formation-service
+  type: github
+service_category: application
+service_title: Resource Formation Service
+service_type: rfs
+service_uri: resource-formation-service
+teams:
+- name: docs-cms-rw
+  permission: write

otc_metadata/data/services/smn.yaml

@@ -12,5 +12,5 @@ service_title: Simple Message Notification
 service_type: smn
 service_uri: simple-message-notification
 teams:
-- name: docs-orchestration-rw
+- name: docs-cms-rw
   permission: write

otc_metadata/data/services/tms.yaml

@@ -12,5 +12,5 @@ service_title: Tag Management Service
 service_type: tms
 service_uri: tag-management-service
 teams:
-- name: docs-orchestration-rw
+- name: docs-cms-rw
   permission: write

otc_metadata/templates/conf.py.j2

@@ -16,6 +16,8 @@
 
 import os
 import sys
+from git import Repo
+from datetime import datetime
 
 extensions = [
     'otcdocstheme',
@@ -117,6 +119,7 @@ html_title = "{{ title }}"
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+templates_path = ['_templates']
 
 # Do not include sources into the rendered results
 html_copy_source = False
@@ -131,3 +134,21 @@ latex_documents = [
 {% endif -%}
 ]
 
+# Get the Git commit values for last updated timestamp on each page
+repo = Repo(search_parent_directories=True)
+commit = repo.head.commit
+current_commit_hash = commit.hexsha
+current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
+
+latex_elements = {
+  'papersize': 'a4paper',
+  'pointsize': '12pt',
+  'figure_align': 'H',
+  'preamble': rf'''{% raw %}
+        \newcommand{{\githash}}{{{current_commit_hash}}}
+        \newcommand{{\gitcommittime}}{{{current_commit_time}}}
+        \newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
+        \newcommand{{\servicetitle}}{{{otcdocs_service_title}}}{% endraw %}
+  ''',
+  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
+}

otc_metadata/templates/doc_requirements.txt.j2

@@ -12,4 +12,5 @@ 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
+setuptools
+gitpython

otc_metadata/templates/tox.ini.j2

@@ -58,6 +58,10 @@ allowlist_externals =
 commands =
   mkdir -p doc/build/pdf
   {[testenv:bindeps]commands}
+  mkdir -p {toxinidir}/_templates
+  wget -O {toxinidir}/_templates/longtable.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/longtable.tex.jinja
+  wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja
+  wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja
 {%- for doc in docs %}
 {%- if doc.pdf_name %}
   {[testenv:{{ doc.type }}-pdf-docs]commands}
@@ -115,6 +119,7 @@ allowlist_externals =
   cp
 commands =
   rm -rf {{ loc }}/build/pdf
+  cp -r {toxinidir}/_templates {{ loc }}/source/_templates/
   sphinx-build -W --keep-going -b latex {{ loc }}/source {{ loc }}/build/pdf/
   bash -c "for f in {{ loc }}/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
   bash -c "for f in {{ loc }}/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"