Rename tox target for pdf build

zuul jobs require target to be called pdf-docs instead of docs-pdf

otc_metadata/data/services.yaml

@@ -293,6 +293,24 @@ documents:
     service_type: dis
     title: User Guide
     type: umn
+  - environment: internal
+    hc_location: api/dli
+    html_location: docs/dli/api-ref
+    link: /data-lake-insight/api-ref/
+    pdf_name: dli-api-ref
+    rst_location: api-ref/source
+    service_type: dli
+    title: API Reference
+    type: api-ref
+  - environment: internal
+    hc_location: usermanual/dli
+    html_location: docs/dli/umn
+    link: /data-lake-insight/umn/
+    pdf_name: dli-umn
+    rst_location: umn/source
+    service_type: dli
+    title: User Guide
+    type: umn
   - hc_location: api/dms
     html_location: docs/dms/api-ref
     link: /distributed-message-service/api-ref/
@@ -673,17 +691,18 @@ documents:
     html_location: docs/obs/pfs
     link: /object-storage-service/parallel-file-system/
     pdf_name: obs-pfs
-    rst_location: doc/pfs/source
+    rst_location: doc/parallel-file-system/source
     service_type: obs
     title: Parallel File System (PFS)
-    type: pfs
-  - html_location: docs/obs/perms-cfg
+    type: parallel-file-system
+  - environment: internal
+    html_location: docs/obs/perms-cfg
     link: /object-storage-service/permissions-configuration-guide/
     pdf_name: obs-perms-cfg
-    rst_location: doc/perms-cfg/source
+    rst_location: doc/permissions-configuration-guide/source
     service_type: obs
     title: Permissions Configuration Guide
-    type: perms-cfg
+    type: permissions-configuration-guide
   - hc_location: api_swift/obs
     html_location: docs/obs/api-swift
     link: /object-storage-service/swiftapi/
@@ -1250,6 +1269,19 @@ services:
     teams:
       - name: docs-network-rw
         permission: write
+  - repositories:
+      - environment: internal
+        repo: docs/data-lake-insight
+        type: gitea
+      - environment: public
+        repo: docs/data-lake-insight
+        type: github
+    service_category: big_data
+    service_title: Data Lake Insight
+    service_type: dli
+    teams:
+      - name: docs-bigdata-ai-rw
+        permission: write
   - repositories:
       - environment: internal
         repo: docs/data-replication-service

otc_metadata/templates/tox.ini.j2

@@ -35,7 +35,7 @@ commands =
   {[testenv:json-{{ doc.type }}]commands}
 {%- endfor %}
 
-[testenv:docs-pdf]
+[testenv:pdf-docs]
 deps = -r{toxinidir}/doc/requirements.txt
 allowlist_externals =
   rm

tools-requirements.txt

@@ -3,3 +3,4 @@ ruamel.yaml
 requests
 jinja2
 dirsync
+cookiecutter

tools/update_zuul_project_configs.py

@@ -130,6 +130,7 @@ def process_repositories(args, service):
         zuul_templates = None
         zuul_jobs = dict()
         zuul_new_jobs = list()
+        zuul_vars = dict()
         zuul_config_updated = False
         for item in zuul_config:
             if "project" in item.keys():
@@ -137,10 +138,11 @@ def process_repositories(args, service):
                 zuul_templates = project.setdefault("templates", [])
                 if not zuul_templates:
                     zuul_templates = []
+                zuul_vars = project.setdefault("vars", {})
             elif "job" in item.keys():
                 job = item["job"]
                 zuul_jobs[job["name"]] = job
-        print(f"Existing jobs {zuul_jobs}")
+        logging.debug(f"Existing jobs {zuul_jobs}")
         if "helpcenter-base-jobs" not in zuul_templates:
             zuul_templates.append("helpcenter-base-jobs")
             zuul_config_updated = True
@@ -148,6 +150,7 @@ def process_repositories(args, service):
         job_suffix = (
             "-hc-int-jobs" if args.environment == "internal" else "-hc-jobs"
         )
+        sphinx_pdf_files = zuul_vars.setdefault('sphinx_pdf_files', [])
         for doc in data.docs_by_service_type(service["service_type"]):
             logging.debug(f"Analyzing document {doc}")
             if not doc.get("type"):
@@ -156,6 +159,12 @@ def process_repositories(args, service):
                 doc_type = "dev-guide"
             else:
                 doc_type = doc["type"]
+            # Collect all PDF files into sphinx_pdf_files var
+            pdf_name = doc.get('pdf_name')
+            if pdf_name and f"{pdf_name}.pdf" not in sphinx_pdf_files:
+                sphinx_pdf_files.append(f"{pdf_name}.pdf")
+                zuul_config_updated = True
+
             template_name = f"{doc_type}{job_suffix}"
             if doc_type in ["api-ref", "umn", "dev-guide"]:
                 if template_name not in zuul_templates:
@@ -190,6 +199,7 @@ def process_repositories(args, service):
                 if "project" in item.keys():
                     project = item["project"]
                     project["templates"] = zuul_templates
+                    project["vars"] = zuul_vars
                     # Ensure new jobs are in check
                     if len(zuul_new_jobs) > 0:
                         project.setdefault(