(flink) branch release-1.17 updated: [FLINK-33567][Documentation] Only display connector download links if its available. This closes #23731

[martijnvisser]

This is an automated email from the ASF dual-hosted git repository.

martijnvisser pushed a commit to branch release-1.17
in repository https://gitbox.apache.org/repos/asf/flink.git


The following commit(s) were added to refs/heads/release-1.17 by this push:
     new 98115db2a57 [FLINK-33567][Documentation] Only display connector 
download links if its available. This closes #23731
98115db2a57 is described below

commit 98115db2a57ca0532a82b433fd2a5d8b59c462ad
Author: MartijnVisser <martijnvis...@apache.org>
AuthorDate: Thu Nov 16 13:19:21 2023 +0100

    [FLINK-33567][Documentation] Only display connector download links if its 
available. This closes #23731
    
    For all download displays, this performs an additional check if there's a 
connector release available for that specific Flink release. If not, it will 
display that there's no connector release yet available for that Flink version.
    
    (cherry picked from commit 39eddc9a7295718e5171d922fb9888efa543c0e9)
---
 docs/layouts/shortcodes/connector_artifact.html    | 36 ++++++++---
 .../shortcodes/py_connector_download_link.html     | 23 +++++--
 .../shortcodes/sql_connector_download_table.html   | 71 +++++++++++++---------
 3 files changed, 87 insertions(+), 43 deletions(-)

diff --git a/docs/layouts/shortcodes/connector_artifact.html 
b/docs/layouts/shortcodes/connector_artifact.html
index 6c3a797ebb1..2513196a3ab 100644
--- a/docs/layouts/shortcodes/connector_artifact.html
+++ b/docs/layouts/shortcodes/connector_artifact.html
@@ -27,17 +27,35 @@ under the License.
 {{ $version := $connector.version  }}
 {{ $path := .Page.Path }}
 
+{{ $connector := index .Site.Data $name }}
+{{ $flink_compatibility := $connector.flink_compatibility  }}
+{{ $flink_version := .Site.Params.VersionTitle }}
+
 {{ $hash := md5 now }}
 
+{{ $containsVersion := false }}
+{{ range $flink_compatibility }}
+    {{ if in . $flink_version }}
+        {{ $containsVersion = true }}
+        {{ printf "Fine" }}
+        {{ break }}
+    {{ end }}
+{{ end }}
+
+
 {{ if $.Site.Params.IsStable }}
-<div id="{{ $hash }}" onclick="selectTextAndCopy('{{ $hash 
}}')"class="highlight"><pre class="chroma"><code class="language-xml" 
data-lang="xml"><span class="nt">&ltdependency&gt</span>
-    <span class="nt">&ltgroupId&gt</span>org.apache.flink<span 
class="nt">&lt/groupId&gt</span>
-    <span class="nt">&ltartifactId&gt</span>{{- $artifactId -}}<span 
class="nt">&lt/artifactId&gt</span>
-    <span class="nt">&ltversion&gt</span>{{- $version -}}-{{- 
site.Params.VersionTitle -}}<span class="nt">&lt/version&gt</span>
-<span class="nt">&lt/dependency&gt</span></code></pre></div>
-<div class="book-hint info" style="text-align:center;display:none" 
copyable="flink-module" copyattribute="{{ $hash }}">
-  Copied to clipboard!
-</div>
+    {{ if $containsVersion }}
+    <div id="{{ $hash }}" onclick="selectTextAndCopy('{{ $hash 
}}')"class="highlight"><pre class="chroma"><code class="language-xml" 
data-lang="xml"><span class="nt">&ltdependency&gt</span>
+        <span class="nt">&ltgroupId&gt</span>org.apache.flink<span 
class="nt">&lt/groupId&gt</span>
+        <span class="nt">&ltartifactId&gt</span>{{- $artifactId -}}<span 
class="nt">&lt/artifactId&gt</span>
+        <span class="nt">&ltversion&gt</span>{{- $version -}}-{{- 
site.Params.VersionTitle -}}<span class="nt">&lt/version&gt</span>
+    <span class="nt">&lt/dependency&gt</span></code></pre></div>
+    <div class="book-hint info" style="text-align:center;display:none" 
copyable="flink-module" copyattribute="{{ $hash }}">
+      Copied to clipboard!
+    </div>
+    {{ else }}
+    <p style="font-weight: bold">There is no connector (yet) available for 
Flink version {{ printf $flink_version }}.</p>
+    {{ end }}
 {{ else }}
-Only available for stable versions.
+    <p style="font-weight: bold">Only available for stable versions.</p>
 {{ end }}
diff --git a/docs/layouts/shortcodes/py_connector_download_link.html 
b/docs/layouts/shortcodes/py_connector_download_link.html
index 39088c684d8..f8930df5533 100644
--- a/docs/layouts/shortcodes/py_connector_download_link.html
+++ b/docs/layouts/shortcodes/py_connector_download_link.html
@@ -21,9 +21,18 @@ Generates an XML snippet for the externalized connector 
python download table.
 {{ $name := .Get 0 }}
 {{ $connector := index .Site.Data $name }}
 {{ $connector_version := $connector.version  }}
+{{ $flink_compatibility := $connector.flink_compatibility  }}
 {{ $flink_version := .Site.Params.VersionTitle }}
 {{ $full_version := printf "%s-%s" $connector_version $flink_version }}
 
+{{ $containsVersion := false }}
+{{ range $flink_compatibility }}
+    {{ if in . $flink_version }}
+        {{ $containsVersion = true }}
+        {{ break }}
+    {{ end }}
+{{ end }}
+
 <p>
 {{ if eq $.Site.Language.Lang "en" }}
 In order to use the {{ $connector.name }} in PyFlink jobs, the following
@@ -41,11 +50,15 @@ dependencies are required:
     <tr>
         <td style="text-align: left">{{- .maven -}}</td>
         {{ if $.Site.Params.IsStable }}
-        {{ if eq .sql_url nil}}
-        <td style="text-align:left">There is no sql jar available yet.</td>
-        {{ else }}
-        <td style="text-align:left"><a href="{{ replace .sql_url 
"$full_version" $full_version}}">Download</a></td>
-        {{ end }}
+            {{ if $containsVersion }}
+                {{ if eq .sql_url nil}}
+                <td style="text-align:left">There is no SQL jar (yet) 
available.</td>
+                {{ else }}
+                <td style="text-align:left"><a href="{{ replace .sql_url 
"$full_version" $full_version}}">Download</a></td>
+                {{ end }}
+            {{ else }}
+            <td>There is no SQL jar (yet) available for Flink version {{ 
printf $flink_version }}.</td>
+            {{ end }}
         {{ else }}
         <td>Only available for stable releases.</td>
         {{ end }}
diff --git a/docs/layouts/shortcodes/sql_connector_download_table.html 
b/docs/layouts/shortcodes/sql_connector_download_table.html
index ff72ac183a3..e80ba7e0232 100644
--- a/docs/layouts/shortcodes/sql_connector_download_table.html
+++ b/docs/layouts/shortcodes/sql_connector_download_table.html
@@ -24,42 +24,55 @@
   {{ $name := .Get 0 }}
   {{ $connector := index .Site.Data $name }}
   {{ $connector_version := $connector.version  }}
+  {{ $flink_compatibility := $connector.flink_compatibility  }}
   {{ $flink_version := .Site.Params.VersionTitle }}
   {{ $full_version := printf "%s-%s" $connector_version $flink_version }}
   
   {{ $path := .Page.Path }}
   
   {{ $hash := md5 now }}
-  
+
+{{ $containsVersion := false }}
+{{ range $flink_compatibility }}
+    {{ if in . $flink_version }}
+        {{ $containsVersion = true }}
+        {{ break }}
+    {{ end }}
+{{ end }}
+
   {{ if $.Site.Params.IsStable }}
-  <table style="display:table;margin-left:auto;margin-right:auto" 
id="download-table">
-    <thead>
-      <th style="text-align:left">Maven dependency</th>
-      <th style="text-align:left">SQL Client</th>
-    </thead>
-    <tbody>
-      {{ range $connector.variants }}
-      <tr>
-        <td style="text-align: left">
-          <div id="{{ $hash }}" onclick="selectTextAndCopy('{{ $hash 
}}')"class="highlight">
-<pre class="chroma"><code class="language-xml" data-lang="xml"><span 
class="nt">&ltdependency&gt</span>
-  <span class="nt">&ltgroupId&gt</span>org.apache.flink<span 
class="nt">&lt/groupId&gt</span>
-  <span class="nt">&ltartifactId&gt</span>{{- .maven -}}<span 
class="nt">&lt/artifactId&gt</span>
-  <span class="nt">&ltversion&gt</span>{{- $full_version -}}<span 
class="nt">&lt/version&gt</span>
-<span class="nt">&lt/dependency&gt</span></code></pre></div>
-          <div class="book-hint info" style="text-align:center;display:none" 
copyable="flink-module" copyattribute="{{ $hash }}">
-            Copied to clipboard!
-          </div> 
-        </td>
-        <td style="text-align: left">
-          <a href="{{ replace .sql_url "$full_version" 
$full_version}}">Download</a>
-        </td>
-      </tr>
-      {{ end }}
-    </tbody>
-  </table>
+    {{ if $containsVersion }}
+      <table style="display:table;margin-left:auto;margin-right:auto" 
id="download-table">
+        <thead>
+          <th style="text-align:left">Maven dependency</th>
+          <th style="text-align:left">SQL Client</th>
+        </thead>
+        <tbody>
+          {{ range $connector.variants }}
+          <tr>
+            <td style="text-align: left">
+              <div id="{{ $hash }}" onclick="selectTextAndCopy('{{ $hash 
}}')"class="highlight">
+    <pre class="chroma"><code class="language-xml" data-lang="xml"><span 
class="nt">&ltdependency&gt</span>
+      <span class="nt">&ltgroupId&gt</span>org.apache.flink<span 
class="nt">&lt/groupId&gt</span>
+      <span class="nt">&ltartifactId&gt</span>{{- .maven -}}<span 
class="nt">&lt/artifactId&gt</span>
+      <span class="nt">&ltversion&gt</span>{{- $full_version -}}<span 
class="nt">&lt/version&gt</span>
+    <span class="nt">&lt/dependency&gt</span></code></pre></div>
+              <div class="book-hint info" 
style="text-align:center;display:none" copyable="flink-module" 
copyattribute="{{ $hash }}">
+                Copied to clipboard!
+              </div>
+            </td>
+            <td style="text-align: left">
+              <a href="{{ replace .sql_url "$full_version" 
$full_version}}">Download</a>
+            </td>
+          </tr>
+          {{ end }}
+        </tbody>
+      </table>
+    {{ else }}
+        <p style="font-weight: bold">There is no connector (yet) available for 
Flink version {{ printf $flink_version }}.</p>
+    {{ end }}
   {{ else }}
-  Only available for stable versions.
+    <p style="font-weight: bold">Only available for stable versions.</p>
   {{ end }}
 
-  
+