You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ma...@apache.org on 2026/01/29 09:06:50 UTC
(flink) branch release-1.12 updated (b1e7b892cc9 -> 51e26fcfaf7)
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a change to branch release-1.12
in repository https://gitbox.apache.org/repos/asf/flink.git
from b1e7b892cc9 [FLINK-25883][python] Set the default value of DEFAULT_BUNDLE_PROCESSOR_CACHE_SHUTDOWN_THRESHOLD_S to 30 days
new 23639897717 [hotfix][docs] Add docs.sh for legacy CI pipeline
new 2a9728d10f2 [FLINK-38925][docs] Update Matomo URL to the right domain
new 898a0f6eddc [FLINK-38914][docs] Add canonical tags pointing to stable docs
new d9d869a6dde [FLINK-38914][docs] Preserve page path when linking to stable version
new 51e26fcfaf7 [FLINK-38955][docs] Add canonical tag to generated Javadoc and Scaladoc
The 5 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.github/workflows/docs.sh | 87 +++++++++++++++++++++++++++++++++++++++++++++++
docs/_config.yml | 2 +-
docs/_layouts/base.html | 6 ++--
docs/_layouts/plain.html | 4 +--
4 files changed, 93 insertions(+), 6 deletions(-)
create mode 100755 .github/workflows/docs.sh
(flink) 01/05: [hotfix][docs] Add docs.sh for legacy CI pipeline
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.12
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 23639897717b1ddb10f4cbb5c7e603e425260c52
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 10:35:54 2026 +0100
[hotfix][docs] Add docs.sh for legacy CI pipeline
Adds GitHub Actions docs.sh script to enable building documentation via the docs-legacy workflow.
---
.github/workflows/docs.sh | 69 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 69 insertions(+)
diff --git a/.github/workflows/docs.sh b/.github/workflows/docs.sh
new file mode 100755
index 00000000000..bbad00fdccd
--- /dev/null
+++ b/.github/workflows/docs.sh
@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+################################################################################
+# 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.
+################################################################################
+set -e
+
+# override env to use Java 8 to for build
+# path to JDK is taken from https://github.com/apache/flink-connector-shared-utils/blob/ci_utils/docker/base/Dockerfile#L37-L40
+export JAVA_HOME=$JAVA_HOME_8_X64
+export PATH=$JAVA_HOME_8_X64/bin:$PATH
+
+mvn --version
+java -version
+javadoc -J-version
+
+# workaround for a git security patch
+git config --global --add safe.directory /root/flink
+
+# Disable Maven's default HTTP blocking for legacy repos
+mkdir -p ~/.m2
+cat > ~/.m2/settings.xml << 'EOF'
+<settings>
+ <mirrors>
+ <mirror>
+ <id>maven-default-http-blocker</id>
+ <mirrorOf>!*</mirrorOf>
+ <url>http://0.0.0.0/</url>
+ </mirror>
+ </mirrors>
+</settings>
+EOF
+
+# Jekyll docs are built in a separate step using docs/docker image
+# Move pre-built docs to target/ for consistency with other branches
+mv docs/content docs/target
+
+# build Flink; required for Javadoc step
+# Skip npm (node permission issues in Docker container)
+mvn clean install -B -DskipTests -Dfast -Dskip.npm
+
+# build java/scala docs
+mkdir -p docs/target/api
+mvn javadoc:aggregate -B \
+ -Paggregate-scaladoc \
+ -DadditionalJOption="-Xdoclint:none --allow-script-in-comments" \
+ -Dmaven.javadoc.failOnError=false \
+ -Dcheckstyle.skip=true \
+ -Dspotless.check.skip=true \
+ -Denforcer.skip=true \
+ -Dheader="<a href=\"http://flink.apache.org/\" target=\"_top\"><h1>Back to Flink Website</h1></a> <script>var _paq=window._paq=window._paq||[];_paq.push([\"disableCookies\"]),_paq.push([\"setDomains\",[\"*.flink.apache.org\",\"*.nightlies.apache.org/flink\"]]),_paq.push([\"trackPageView\"]),_paq.push([\"enableLinkTracking\"]),function(){var u=\"//analytics.apache.org/\";_paq.push([\"setTrackerUrl\",u+\"matomo.php\"]),_paq.push([\"setSiteId\",\"1\"]);var d=document, g=d.createElement( [...]
+mv target/site/apidocs docs/target/api/java
+pushd flink-scala
+mvn scala:doc -B
+mv target/site/scaladocs ../docs/target/api/scala
+popd
(flink) 05/05: [FLINK-38955][docs] Add canonical tag to generated Javadoc and Scaladoc
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.12
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 51e26fcfaf7f4d02faa6b698fba77cfeda168110
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Wed Jan 21 15:42:51 2026 +0100
[FLINK-38955][docs] Add canonical tag to generated Javadoc and Scaladoc
(cherry picked from commit 8226f3b8b0f2da1fd5ed9d12ca1036551d6e4229)
---
.github/workflows/docs.sh | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/.github/workflows/docs.sh b/.github/workflows/docs.sh
index bbad00fdccd..23947a9fd24 100755
--- a/.github/workflows/docs.sh
+++ b/.github/workflows/docs.sh
@@ -62,8 +62,26 @@ mvn javadoc:aggregate -B \
-Dspotless.check.skip=true \
-Denforcer.skip=true \
-Dheader="<a href=\"http://flink.apache.org/\" target=\"_top\"><h1>Back to Flink Website</h1></a> <script>var _paq=window._paq=window._paq||[];_paq.push([\"disableCookies\"]),_paq.push([\"setDomains\",[\"*.flink.apache.org\",\"*.nightlies.apache.org/flink\"]]),_paq.push([\"trackPageView\"]),_paq.push([\"enableLinkTracking\"]),function(){var u=\"//analytics.apache.org/\";_paq.push([\"setTrackerUrl\",u+\"matomo.php\"]),_paq.push([\"setSiteId\",\"1\"]);var d=document, g=d.createElement( [...]
+
+# Inject canonical tags into Javadoc HTML files to point to stable docs version
+CANONICAL_BASE="https://nightlies.apache.org/flink/flink-docs-stable/api/java"
+find target/site/apidocs -name "*.html" -type f | while read -r file; do
+ REL_PATH="${file#target/site/apidocs/}"
+ CANONICAL_URL="${CANONICAL_BASE}/${REL_PATH}"
+ sed -i "s|<head>|<head>\n<link rel=\"canonical\" href=\"${CANONICAL_URL}\">|" "$file"
+done
+
mv target/site/apidocs docs/target/api/java
pushd flink-scala
mvn scala:doc -B
+
+# Inject canonical tags into Scaladoc HTML files to point to stable docs version
+CANONICAL_BASE="https://nightlies.apache.org/flink/flink-docs-stable/api/scala"
+find target/site/scaladocs -name "*.html" -type f | while read -r file; do
+ REL_PATH="${file#target/site/scaladocs/}"
+ CANONICAL_URL="${CANONICAL_BASE}/${REL_PATH}"
+ sed -i "s|<head>|<head>\n<link rel=\"canonical\" href=\"${CANONICAL_URL}\">|" "$file"
+done
+
mv target/site/scaladocs ../docs/target/api/scala
popd
(flink) 03/05: [FLINK-38914][docs] Add canonical tags pointing to stable docs
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.12
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 898a0f6eddc65cd5354d7bb102c894467ddd1a03
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 10:37:16 2026 +0100
[FLINK-38914][docs] Add canonical tags pointing to stable docs
All documentation pages now include a canonical link tag pointing to the stable version (flink-docs-stable). This prevents search engines from indexing duplicate content across master, release, and stable versions, consolidating SEO value on the stable docs where users should land.
---
docs/_config.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index 0d6ceb3cc54..b625bc14772 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -49,7 +49,7 @@ zh_download_url: "https://flink.apache.org/zh/downloads.html"
# please use a protocol relative URL here
baseurl: //ci.apache.org/projects/flink/flink-docs-release-1.12
-stable_baseurl: //ci.apache.org/projects/flink/flink-docs-stable
+stable_baseurl: //nightlies.apache.org/flink/flink-docs-stable
javadocs_baseurl: //ci.apache.org/projects/flink/flink-docs-release-1.12
pythondocs_baseurl: //ci.apache.org/projects/flink/flink-docs-release-1.12
(flink) 04/05: [FLINK-38914][docs] Preserve page path when linking to stable version
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.12
in repository https://gitbox.apache.org/repos/asf/flink.git
commit d9d869a6dde198de77b8acb28a70ad5d17371e89
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 10:37:46 2026 +0100
[FLINK-38914][docs] Preserve page path when linking to stable version
The "stable version" link in the warning banner for unreleased/out-of-date docs now redirects to the equivalent page in the stable docs instead of always redirecting to the homepage.
---
docs/_layouts/base.html | 4 ++--
docs/_layouts/plain.html | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 8d56d34af76..4809a9e3a49 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -77,9 +77,9 @@ under the License.
{% if site.show_outdated_warning %}
<div style="position:fixed; bottom:0; left:0; z-index:99999; width:100%; text-align:center; padding:15px; border-top:5px solid #ECCCD1; background:#F2DEDE; color:#AD433F; font-weight:bold">
{% if page.language == "en" %}
- This documentation is for an out-of-date version of Apache Flink. We recommend you use <a href="https://ci.apache.org/projects/flink/flink-docs-stable/">the latest stable version</a>.
+ This documentation is for an out-of-date version of Apache Flink. We recommend you use <a href="{{ site.stable_baseurl }}{{ page.url | replace:'index.html','' }}">the latest stable version</a>.
{% else if page.language == "zh" %}
- 本文档是 Apache Flink 的旧版本。建议访问 <a href="https://ci.apache.org/projects/flink/flink-docs-stable/zh">最新的稳定版本</a>。
+ 本文档是 Apache Flink 的旧版本。建议访问 <a href="{{ site.stable_baseurl }}{{ page.url | replace:'index.html','' }}">最新的稳定版本</a>。
{% endif %}
</div>
{% endif %}
diff --git a/docs/_layouts/plain.html b/docs/_layouts/plain.html
index bcde9f2dda6..0f8c738d76a 100644
--- a/docs/_layouts/plain.html
+++ b/docs/_layouts/plain.html
@@ -56,9 +56,9 @@ under the License.
{% if site.show_outdated_warning %}
<div class="alert alert-danger" role="alert">
{%- if page.language == "en" %}
- <strong>This documentation is for an out-of-date version of Apache Flink. We recommend you use <a href="https://ci.apache.org/projects/flink/flink-docs-stable/">the latest stable version</a>.</strong>
+ <strong>This documentation is for an out-of-date version of Apache Flink. We recommend you use <a href="https://nightlies.apache.org/flink/flink-docs-stable{{ page.url }}">the latest stable version</a>.</strong>
{%- else if page.language == "zh" %}
- <strong>本文档是 Apache Flink 的旧版本。建议访问 <a href="https://ci.apache.org/projects/flink/flink-docs-stable/zh">最新的稳定版本</a>。</strong>
+ <strong>本文档是 Apache Flink 的旧版本。建议访问 <a href="https://nightlies.apache.org/flink/flink-docs-stable{{ page.url }}">最新的稳定版本</a>。</strong>
{%- endif %}
</div>
{%- endif %}
(flink) 02/05: [FLINK-38925][docs] Update Matomo URL to the right domain
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.12
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 2a9728d10f2f64878e64fac7790a43810de6278d
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 10:37:07 2026 +0100
[FLINK-38925][docs] Update Matomo URL to the right domain
---
docs/_layouts/base.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 3794d04cc92..8d56d34af76 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -64,7 +64,7 @@ under the License.
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
- var u="//matomo.privacy.apache.org/";
+ var u="//analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '1']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];