You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/12/12 12:18:12 UTC

[GitHub] [flink] zentol opened a new pull request, #21492: [FLINK-30378][docs] Add v2 sql_connector_download_table shortcode

zentol opened a new pull request, #21492:
URL: https://github.com/apache/flink/pull/21492

   Adds a new shortcode for generating the sql download table for externalized connectors.
   Further decouples the Flink/connector docs by no longer relying on docs/data/sql_connectors.yml.
   
   Usage:
   ```
   some_document.md:
   {{< sql_connector_download_table_v2 "elasticsearch" 3.0.0 >}}
   
   docs/data/elasticsearch.yml:
   variants:
     - maven: flink-connector-elasticsearch6
       sql_url: https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-elasticsearch6/$full_version/flink-sql-connector-elasticsearch6-$full_version.jar
     - maven: flink-connector-elasticsearch7
       sql_url: https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-elasticsearch7/$full_version/flink-sql-connector-elasticsearch7-$full_version.jar
   ```
   
   @dannycranmer You may be interested in this one.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [flink] flinkbot commented on pull request #21492: [FLINK-30378][docs] Add v2 sql_connector_download_table shortcode

Posted by GitBox <gi...@apache.org>.
flinkbot commented on PR #21492:
URL: https://github.com/apache/flink/pull/21492#issuecomment-1346391153

   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "7f69cef11ff42cd53e758e2bf428e2942bacbcf9",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "7f69cef11ff42cd53e758e2bf428e2942bacbcf9",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 7f69cef11ff42cd53e758e2bf428e2942bacbcf9 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [flink] zentol commented on a diff in pull request #21492: [FLINK-30378][docs] Add v2 sql_connector_download_table shortcode

Posted by GitBox <gi...@apache.org>.
zentol commented on code in PR #21492:
URL: https://github.com/apache/flink/pull/21492#discussion_r1081201261


##########
docs/setup_docs.sh:
##########
@@ -27,19 +27,12 @@ function integrate_connector_docs {
   local connector ref additional_folders
   connector=$1
   ref=$2
-  additional_folders=( "${@:3}" )
 
   git clone --single-branch --branch ${ref} https://github.com/apache/flink-connector-${connector}
   theme_dir="../themes/connectors"
   mkdir -p "${theme_dir}"
 
-  for rsync_folder_subpath in "docs/content" "docs/content.zh" "${additional_folders[@]}"; do
-    local rsync_source_path="flink-connector-${connector}/${rsync_folder_subpath}"

Review Comment:
   This was removed because syncing the entire docs directory is simpler.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [flink] zentol commented on a diff in pull request #21492: [FLINK-30378][docs] Add v2 sql_connector_download_table shortcode

Posted by GitBox <gi...@apache.org>.
zentol commented on code in PR #21492:
URL: https://github.com/apache/flink/pull/21492#discussion_r1045758661


##########
docs/layouts/shortcodes/sql_connector_download_table_v2.html:
##########
@@ -0,0 +1,65 @@
+{{/*
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+  
+    http://www.apache.org/licenses/LICENSE-2.0
+  
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+  */}}
+  {{/* 
+    Generates an XML snippet for the SQL connector download table. 
+    IMPORTANT: the whitespace is relevant. Do not change without looking at the 
+    rendered documentation. 
+  */}}
+  {{ $name := .Get 0 }}
+  {{ $connector_version := .Get 1 }}
+  {{ $connector := index .Site.Data $name }}
+  {{ $flink_version := .Site.Params.VersionTitle }}
+  {{ $full_version := printf "%s-%s" $connector_version $flink_version }}
+  
+  {{ $path := .Page.Path }}
+  
+  {{ $hash := md5 now }}
+  
+  {{ 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 }}

Review Comment:
   This was renamed to `variants` because we have enough "versions" flying around in this file.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [flink] zentol merged pull request #21492: [FLINK-30378][docs] Add v2 sql_connector_download_table shortcode

Posted by GitBox <gi...@apache.org>.
zentol merged PR #21492:
URL: https://github.com/apache/flink/pull/21492


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org