Add zendesk tag support (#979)

dgarcia360 · web-flow · commit 8fd93adc9461 · 2024-01-05T13:30:10.000Z
* Add Zendesk verification tag support to main index.html page

* Fix test
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -100,7 +100,6 @@
 smv_released_pattern = r"^tags/.*$"
 # Format for versioned output directories inside the build directory
 smv_outputdir_format = "{ref.name}"
-
 # -- Options for HTML output ----------------------------------------
 
 # The theme to use for pages.
@@ -118,6 +117,7 @@
     "github_repository": "scylladb/sphinx-scylladb-theme",
     "site_description": "Sphinx Theme for ScyllaDB projects.",
     "hide_version_dropdown": ["master"],
+    "zendesk_tag": "gq6ltsh3nfex3cnwfy4aj9",
     "versions_unstable": UNSTABLE_VERSIONS,
     "versions_deprecated": DEPRECATED_VERSIONS,
 }
diff --git a/docs/source/configuration/template.rst b/docs/source/configuration/template.rst
@@ -282,3 +282,27 @@ Configuration options for the like and dislike buttons shown at the bottom of th
   html_theme_options = {
       'hide_feedback_buttons': 'true',
   }
+
+Zendesk options
+---------------
+
+Configuration options for enabling zendesk.
+
+.. list-table::
+  :widths: 20 20 20 40
+  :header-rows: 1
+
+  * - Option
+    - Type
+    - Default Value
+    - Description
+  * - ``zendesk_tag``
+    - string
+    - 
+    - Zendesk verification tag. Example: ``gq6ltsh3nfex3cnwfy4aj9``.
+
+.. code:: python
+
+  html_theme_options = {
+      'zendesk_tag': 'gq6ltsh3nfex3cnwfy4aj9',
+  }
diff --git a/docs/source/upgrade/CHANGELOG.md b/docs/source/upgrade/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.6.6 - 5 Jan 2024
+
+### Updated
+
+- [#949](https://github.com/scylladb/sphinx-scylladb-theme/pull/949): Enhances Zendesk verification tag support.
+
 ## 1.6.5 - 18 Dec 2023
 
 ### Fixed
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sphinx-scylladb-theme"
-version = "1.6.5"
+version = "1.6.6"
 description = "A Sphinx Theme for ScyllaDB documentation projects"
 authors = ["David García <hi@davidgarcia.dev>"]
 exclude = [".github", "config", "docs", "extensions", ".postcss.config.js", ".prettierrc.json", "deploy.sh", "src", "package.json", "package-lock.json"]
diff --git a/sphinx_scylladb_theme/extensions/multiversion.py b/sphinx_scylladb_theme/extensions/multiversion.py
@@ -82,9 +82,11 @@ def create_redirect_to_latest_version(app, exception):
 
     out_dir = Path(app.builder.outdir)
     head = out_dir.parent
+    theme_options = app.config.html_theme_options
+    zendesk_tag = theme_options.get("zendesk_tag", '')
 
     with open(head / "index.html", "w+") as t_file:
-        t_file.write(build_redirect_body(latest_dir))
+        t_file.write(build_redirect_body(latest_dir, zendesk_tag))
 
 
 def setup(app):
diff --git a/sphinx_scylladb_theme/extensions/utils.py b/sphinx_scylladb_theme/extensions/utils.py
@@ -36,25 +36,33 @@ def copy(src, dest):
             shutil.copy(src, dest)
 
 
-def build_redirect_body(path):
+def build_redirect_body(path, zendesk_tag=''):
     """
     Builds the contents of the redirection file.
 
     :param path: Path to redirect to.
     :type path: str
 
+    :param zendesk_tag: Zendesk tag.
+    :type zendesk_tag: str
+
     :return: HTML body of the redirection.
     :rtype: str
     """
+
+    zendesk_tag_html = f'<meta name="zd-site-verification" content="{zendesk_tag}" />' if zendesk_tag else ''
+
     html = generate_template(
         """
         <html>
         <head>
+        {zendesk_tag_html}
         <meta http-equiv="refresh" content="0; url={path}">
         </head>
         </html>
         """,
         path=path,
+        zendesk_tag_html=zendesk_tag_html
     )
     return html
 
diff --git a/sphinx_scylladb_theme/local-scripts.html b/sphinx_scylladb_theme/local-scripts.html
@@ -1,2 +1 @@
-<!-- Zendesk tag -->
-<meta name='zd-site-verification' content='gq6ltsh3nfex3cnwfy4aj9' />
+<!-- Local meta tags -->
diff --git a/sphinx_scylladb_theme/theme.conf b/sphinx_scylladb_theme/theme.conf
@@ -25,4 +25,5 @@ scylladb_scripts = true
 tag_substring_removed = -scylla
 versions_unstable =
 versions_deprecated=
+zendesk_tag=
 skip_warnings=
diff --git a/tests/extensions/test_extensions_utils.py b/tests/extensions/test_extensions_utils.py
@@ -19,7 +19,21 @@ def test_generate_content():
 
 def test_build_redirect_body():
     path = "/redirect"
-    assert "url=/redirect" in build_redirect_body(path)
+    result = build_redirect_body(path)
+    assert "url=/redirect" in result
+    assert "zendesk" not in result
+
+
+def test_build_redirect_body_with_zendesk_tag():
+    path = "/redirect"
+    zendesk_tag = "test-zendesk-tag"
+
+    # Call the function with a Zendesk tag
+    result = build_redirect_body(path, zendesk_tag)
+
+    # Check if the Zendesk meta tag is in the result
+    assert zendesk_tag in result
+    assert "url=/redirect" in result
 
 
 def test_is_url_external():

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`		`-<!-- Zendesk tag -->`
`2`		`-<meta name='zd-site-verification' content='gq6ltsh3nfex3cnwfy4aj9' />`
	`1`	`+<!-- Local meta tags -->`