PDF Preparations

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>

.gitignore

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

otc_metadata/data/documents/as-dev.yaml

@@ -1,9 +0,0 @@
----
-hc_location: devg/as
-html_location: docs/as/dev
-link: /auto-scaling/dev-guide/
-pdf_name: as-dev-guide
-rst_location: dev_guide/source
-service_type: as
-title: Developer Guide
-type: dev

otc_metadata/data/documents/ecs-dev.yaml

@@ -1,9 +0,0 @@
----
-hc_location: devg/ecs
-html_location: docs/ecs/dev
-link: /elastic-cloud-server/dev-guide/
-pdf_name: ecs-dev-guide
-rst_location: dev_guide/source
-service_type: ecs
-title: Developer Guide
-type: dev

otc_metadata/data/documents/evs-dev.yaml

@@ -1,9 +0,0 @@
----
-hc_location: devg/evs
-html_location: docs/evs/dev
-link: /elastic-volume-service/dev-guide/
-pdf_name: evs-dev-guide
-rst_location: dev_guide/source
-service_type: evs
-title: Developer Guide
-type: dev

otc_metadata/data/documents/iam-permissions.yaml

@@ -0,0 +1,8 @@
+---
+html_location: docs/iam/permissions
+link: /identity-access-management/permissions/
+pdf_name: iam-permissions
+rst_location: doc/permissions/source
+service_type: iam
+title: Permissions
+type: permissions

otc_metadata/data/documents/ims-dev.yaml

@@ -1,9 +0,0 @@
----
-hc_location: devg/ims
-html_location: docs/ims/dev
-link: /image-management-service/dev-guide/
-pdf_name: ims-dev-guide
-rst_location: dev_guide/source
-service_type: ims
-title: Developer Guide
-type: dev

otc_metadata/data/documents/ims-public-images.yaml

@@ -1,8 +0,0 @@
----
-html_location: docs/ims/public-images
-link: /image-management-service/public-images/
-pdf_name: ims-public-images
-rst_location: doc/public-images/source
-service_type: ims
-title: Public Image Introduction
-type: public-images

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

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: api/lts
+html_location: docs/lts/api-ref
+link: /log-tank-service/api-ref/
+pdf_name: lts-api-ref
+rst_location: api-ref/source
+service_type: lts
+title: API Reference
+type: api-ref

otc_metadata/data/documents/lts-umn.yaml

@@ -0,0 +1,10 @@
+---
+environment: internal
+hc_location: usermanual/lts
+html_location: docs/lts/umn
+link: /log-tank-service/umn/
+pdf_name: lts-umn
+rst_location: umn/source
+service_type: lts
+title: User Guide
+type: umn

otc_metadata/data/documents/obs-parallel-file-system.yaml

@@ -1,9 +0,0 @@
----
-hc_location: pfs/obs
-html_location: docs/obs/pfs
-link: /object-storage-service/parallel-file-system/
-pdf_name: obs-pfs
-rst_location: doc/parallel-file-system/source
-service_type: obs
-title: Parallel File System (PFS)
-type: parallel-file-system

otc_metadata/data/documents/obs-permissions-configuration-guide.yaml

@@ -1,8 +0,0 @@
----
-html_location: docs/obs/perms-cfg
-link: /object-storage-service/permissions-configuration-guide/
-pdf_name: obs-perms-cfg
-rst_location: doc/permissions-configuration-guide/source
-service_type: obs
-title: Permissions Configuration Guide
-type: permissions-configuration-guide

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)
-type: swiftapi

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/wafd-api-ref.yaml

@@ -1,5 +1,4 @@
 ---
-environment: internal
 hc_location: api/dwaf
 html_location: docs/wafd/api-ref
 link: /web-application-firewall-dedicated/api-ref/

otc_metadata/data/documents/wafd-umn.yaml

@@ -1,5 +1,4 @@
 ---
-environment: internal
 hc_location: usermanual/dwaf
 html_location: docs/wafd/umn
 link: /web-application-firewall-dedicated/umn/

otc_metadata/data/service_categories/big_data.yaml

@@ -1,3 +0,0 @@
----
-name: big_data
-title: Big Data and Data Analysis

otc_metadata/data/service_categories/database.yaml

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

otc_metadata/data/services/lts.yaml

@@ -0,0 +1,16 @@
+---
+environment: internal
+repositories:
+- environment: internal
+  repo: docs-swiss/log-tank-service
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs-swiss/log-tank-service
+  type: github
+service_category: md
+service_title: Log Tank Service
+service_type: lts
+service_uri: log-tank-service
+teams:
+- name: docs-orchestration-rw
+  permission: write

otc_metadata/data/services/sd.yaml

@@ -0,0 +1,16 @@
+---
+repositories:
+- environment: internal
+  repo: docs-swiss/status-dashboard
+  type: gitea
+- environment: public
+  repo: opentelekomcloud-docs-swiss/status-dashboard
+  type: github
+service_category: other
+service_title: Status Dashboard
+service_type: sd
+service_uri: status-dashboard/umn
+environment: hidden
+teams:
+- name: docs-eco-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',
@@ -37,6 +39,18 @@ otcdocs_git_fqdn = '{{ git_fqdn }}'
 otcdocs_git_type = '{{ git_type }}'
 {%- endif %}
 
+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = '{{ doc_environment }}'
+otcdocs_doc_link = '{{ doc_link }}'
+otcdocs_doc_title = '{{ doc_title }}'
+otcdocs_doc_type = '{{ doc_type }}'
+otcdocs_service_category = '{{ service_category }}'
+otcdocs_service_title = '{{ service_title }}'
+otcdocs_service_type = '{{ service_type }}'
+otcdocs_search_environment = 'hc_swiss'
+otcdocs_search_index = 'search_index_swiss'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -106,6 +120,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
@@ -120,3 +135,16 @@ 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': r'\newcommand{\githash}{' + current_commit_hash + '}',
+  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
+}

otc_metadata/templates/doc_requirements.txt.j2

@@ -1,7 +1,16 @@
 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-swiss.git#egg=otc_metadata
+setuptools
+gitpython

otc_metadata/templates/index_sbv.rst.j2

@@ -5,3 +5,4 @@
 
    .. service_card::
       :service_type: {{ service_type }}
+      :environment: {{ environment }}

otc_metadata/templates/zuul.yaml.j2

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

tools/generate_doc_gitcontrol_repos.py

@@ -32,9 +32,11 @@ def process_services(args, services):
         block_on_rejected_reviews=True,
         dismiss_stale_approvals=True,
         enable_push=False,
+        enable_status_check=True,
         status_check_contexts=["gl/check"],
         enable_merge_whitelist=True,
         merge_whitelist_usernames=["zuul"],
+        required_approvals=1,
     )
     gitea_repo_template = dict(
         default_branch="main",

tools/generate_docexports_data.py

@@ -10,6 +10,7 @@ import otc_metadata.services
 
 def main():
     data = otc_metadata.services.Services()
+    data._sort_data()
 
     _yaml = YAML()
     _yaml.indent(mapping=2, sequence=4, offset=2)