updating run.yaml for parameters needed for confpy generator

Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>

playbooks/run.yaml

@@ -25,7 +25,13 @@
         dest: "{{ ansible_user_dir }}/{{ doc.0.repository }}/{{ doc.1.rst_location }}"
         source: "{{ zuul.project.src_dir }}/{{ doc.1.html_location }}"
         doc_title: "{{ [ doc.0.service_title, doc.1.title ] | join(' - ') }}"
+        doc_short_title: "{{ doc.1.title | default(None) }}"
+        doc_environment: "{{ doc.0.service_environment | default(None) }}"
+        doc_link: "{{ doc.1.link | default(None) }}"
+        doc_type: "{{ doc.1.type | default(None) }}"
         doc_service: "{{ doc.0.service_title | default(None) }}"
+        doc_service_category: "{{ doc.0.service_category | default(None) }}"
+        doc_service_type: "{{ doc.0.service_type | default(None) }}"
         doc_repo_name: "{{ doc.0.repository | default(None) }}"
         doc_pdf_name: "{{ doc.1.pdf_name | default(None) }}"
       loop: "{{ doc_exports_var | subelements('docs') }}"

roles/convert_doc/tasks/main.yaml

@@ -20,6 +20,34 @@
     - "doc_title is defined"
     - "doc_title | length > 0"
 
+- name: Add document title to parameters
+  ansible.builtin.set_fact:
+    convert_params: "{{ convert_params }} --doc-title '{{ doc_short_title }}'"
+  when:
+    - "doc_short_title is defined"
+    - "doc_short_title | length > 0"
+
+- name: Add environment to parameters
+  ansible.builtin.set_fact:
+    convert_params: "{{ convert_params }} --doc-environment '{{ doc_environment }}'"
+  when:
+    - "doc_environment is defined"
+    - "doc_environment | length > 0"
+
+- name: Add link to parameters
+  ansible.builtin.set_fact:
+    convert_params: "{{ convert_params }} --doc-link '{{ doc_link }}'"
+  when:
+    - "doc_link is defined"
+    - "doc_link | length > 0"
+
+- name: Add documentation type to parameters
+  ansible.builtin.set_fact:
+    convert_params: "{{ convert_params }} --doc-type '{{ doc_type }}'"
+  when:
+    - "doc_type is defined"
+    - "doc_type | length > 0"
+
 - name: Add service to parameters
   ansible.builtin.set_fact:
     convert_params: "{{ convert_params }} --service '{{ doc_service }}'"
@@ -27,6 +55,27 @@
     - "doc_service is defined"
     - "doc_service | length > 0"
 
+- name: Add service title to parameters
+  ansible.builtin.set_fact:
+    convert_params: "{{ convert_params }} --service-title '{{ doc_service }}'"
+  when:
+    - "doc_service is defined"
+    - "doc_service | length > 0"
+
+- name: Add service category to parameters
+  ansible.builtin.set_fact:
+    convert_params: "{{ convert_params }} --service-category '{{ doc_service_category }}'"
+  when:
+    - "doc_service_category is defined"
+    - "doc_service_category | length > 0"
+
+- name: Add service type to parameters
+  ansible.builtin.set_fact:
+    convert_params: "{{ convert_params }} --service-type '{{ doc_service_type }}'"
+  when:
+    - "doc_service_type is defined"
+    - "doc_service_type | length > 0"
+
 - name: Add repo_name to parameters
   ansible.builtin.set_fact:
     convert_params: "{{ convert_params }} --repo-name '{{ doc_repo_name }}'"

templates/conf.py

@@ -30,6 +30,17 @@ otcdocs_repo_name = '{{ repo_name }}'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'
 
+# 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_de'
+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.