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/02/03 15:25:26 UTC
(flink) branch release-1.10 updated (e4ef133b168 -> dacb17a7543)
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a change to branch release-1.10
in repository https://gitbox.apache.org/repos/asf/flink.git
from e4ef133b168 [FLINK-25880][docs] Add Matomo tracking code to base layout
new 83f0fc101b3 [hotfix][docs] Add docs.sh for legacy CI pipeline
new e72e7dd0048 [FLINK-38925][docs] Update Matomo URL to the right domain
new cbe4ea0a7db [FLINK-38914][docs] Add canonical tags pointing to stable docs
new bf5d87596f9 [FLINK-38914][docs] Preserve page path when linking to stable version
new fff17154194 [FLINK-38955][docs] Add canonical tag to generated Javadoc and Scaladoc
new dacb17a7543 [FLINK-38955][docs] Configure canonical tag for PyDocs
The 6 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 +--
flink-python/docs/conf.py | 3 ++
5 files changed, 96 insertions(+), 6 deletions(-)
create mode 100755 .github/workflows/docs.sh
(flink) 01/06: [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.10
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 83f0fc101b3eaa6969e6935953345764b43945dd
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) 06/06: [FLINK-38955][docs] Configure canonical tag for PyDocs
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.10
in repository https://gitbox.apache.org/repos/asf/flink.git
commit dacb17a7543df74ae90758faa3e26f8bcb72ea1f
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Wed Jan 21 09:08:11 2026 +0100
[FLINK-38955][docs] Configure canonical tag for PyDocs
(cherry picked from commit d7627468b3952b710ef544ea1dc9b74e43737e04)
---
flink-python/docs/conf.py | 3 +++
1 file changed, 3 insertions(+)
diff --git a/flink-python/docs/conf.py b/flink-python/docs/conf.py
index 598ba6b67cf..72c0632c7f0 100644
--- a/flink-python/docs/conf.py
+++ b/flink-python/docs/conf.py
@@ -108,6 +108,9 @@ html_theme = 'nature'
#
# html_theme_options = {}
+# Base URL for canonical links, pointing to stable docs version
+html_baseurl = "https://nightlies.apache.org/flink/flink-docs-stable/api/python/"
+
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "../../docs/page/img/navbar-brand-logo.jpg"
(flink) 02/06: [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.10
in repository https://gitbox.apache.org/repos/asf/flink.git
commit e72e7dd0048546f4a54c71f97c81edaed0977bb9
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 be0e7705dbb..81760123eff 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];
(flink) 05/06: [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.10
in repository https://gitbox.apache.org/repos/asf/flink.git
commit fff1715419472fce0af7a6663699ab1fbfbaa4d0
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) 04/06: [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.10
in repository https://gitbox.apache.org/repos/asf/flink.git
commit bf5d87596f947675ca9c8c81fcab7dd6766a779e
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 81760123eff..267e55d4957 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 e639e55a24b..d5cc4add8ef 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) 03/06: [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.10
in repository https://gitbox.apache.org/repos/asf/flink.git
commit cbe4ea0a7dba90e6b7d7212b758870e395fdf70d
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 10:37:16 2026 -0800
[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 e07009a565f..d8c88172be1 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -52,7 +52,7 @@ download_url: "https://flink.apache.org/downloads.html"
# please use a protocol relative URL here
baseurl: //ci.apache.org/projects/flink/flink-docs-release-1.10
-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.10
pythondocs_baseurl: //ci.apache.org/projects/flink/flink-docs-release-1.10