This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 2ae3024 [FLINK-23581][docs] Fix links to download page
2ae3024 is described below
commit 2ae30249719dd090ee76be7fb3576bf85561af05
Author: hapihu <[email protected]>
AuthorDate: Thu Aug 5 14:49:46 2021 +0800
[FLINK-23581][docs] Fix links to download page
---
docs/README.md | 32 ++++++++++++++--------
docs/config.toml | 10 +++++--
.../resource-providers/standalone/overview.md | 2 +-
.../docs/deployment/resource-providers/yarn.md | 4 +--
.../datastream/fault-tolerance/queryable_state.md | 2 +-
docs/content.zh/docs/flinkDev/building.md | 2 +-
docs/content.zh/docs/libs/gelly/overview.md | 2 +-
.../docs/try-flink/local_installation.md | 2 +-
docs/content.zh/release-notes/flink-1.8.md | 2 +-
.../resource-providers/standalone/overview.md | 2 +-
.../docs/deployment/resource-providers/yarn.md | 6 ++--
.../datastream/fault-tolerance/queryable_state.md | 2 +-
docs/content/docs/flinkDev/building.md | 2 +-
docs/content/docs/libs/gelly/overview.md | 2 +-
docs/content/docs/try-flink/local_installation.md | 2 +-
docs/content/release-notes/flink-1.8.md | 2 +-
docs/layouts/shortcodes/downloads.html | 28 +++++++++++++++++++
17 files changed, 73 insertions(+), 31 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 7aab7b5..f19cda3 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -52,7 +52,7 @@ In addition to Markdown, every page contains a Jekyll front
matter, which specif
---
title: "Title of the Page"
---
-
+
---
title: "Title of the Page" <-- Title rendered in the side nave
weight: 1 <-- Weight controls the ordering of pages in the side nav.
@@ -124,7 +124,7 @@ This will be replaced by a back to top link. It is
recommended to use these link
{{< hint info >}}
Some interesting information
{{< /hint >}}
-
+
The hint will be rendered in a blue box. This hint is useful when providing
additional information for the user that does not fit into the flow of the
documentation.
@@ -150,20 +150,20 @@ functionality.
#### Label
{{< label "My Label" >}}
-
+
The label will be rendered in an inlined blue box. This is useful for labeling
functionality
such as whether a SQL feature works for only batch or streaming execution.
#### Flink version
{{< version >}}
-
+
Interpolates the current Flink version
#### Scala Version
{{< scala_verison >}}
-
+
Interpolates the default scala version
#### Stable
@@ -171,7 +171,7 @@ Interpolates the default scala version
{{< stable >}}
Some content
{{< /stable >}}
-
+
This shortcode will only render its content if the site is marked as stable.
#### Unstable
@@ -179,13 +179,13 @@ This shortcode will only render its content if the site
is marked as stable.
{{< unstable >}}
Some content
{{< /unstable >}}
-
+
This shortcode will only render its content if the site is marked as unstable.
#### Query State Warning
{{< query_state_warning >}}
-
+
Will render a warning the current SQL feature may have unbounded state
requirements.
#### tab
@@ -202,22 +202,22 @@ Will render a warning the current SQL feature may have
unbounded state requireme
```
{< /tab >}}
{{< /tabs }}
-
+
Prints the content in tabs. IMPORTANT: The label in the outermost "tabs"
shortcode must
be unique for the page.
#### Github Repo
{{< github_repo >}}
-
+
Renders a link to the apache flink repo.
#### Github Link
{{< gh_link file="/some/file.java" name="Some file" >}}
-
+
Renders a link to a file in the Apache Flink repo with a given name.
-
+
#### JavaDocs Link
{{< javadoc file="some/file" name="Some file" >}}
@@ -227,3 +227,11 @@ Renders a link to a file in the Apache Flink Java
Documentation.
{< pythondoc file="some/file" name="Some file" >}}
Renders a link to a file in the Apache Flink Python Documentation.
+
+#### FlinkDownloads Link
+
+```
+{{< downloads >}}
+```
+
+Renders a link to the apache flink download page.
diff --git a/docs/config.toml b/docs/config.toml
index 5f21cd2..aa30360 100644
--- a/docs/config.toml
+++ b/docs/config.toml
@@ -24,8 +24,8 @@ pygmentsUseClasses = true
[params]
# Flag whether this is a stable version or not.
# Used for the quickstart page.
- IsStable = false
-
+ IsStable = false
+
# Flag to indicate whether an outdated warning should be shown.
ShowOutDatedWarning = false
@@ -48,7 +48,7 @@ pygmentsUseClasses = true
GithubRepo = "https://github.com/apache/flink.git";
- # Flink training exercises
+ # Flink training exercises
TrainingExercises = "//github.com/apache/flink-training"
# This suffix is appended to the Scala-dependent Maven artifact names
@@ -56,6 +56,10 @@ pygmentsUseClasses = true
ProjectHomepage = "//flink.apache.org"
+ DownloadPage = "//flink.apache.org/downloads.html"
+
+ ZhDownloadPage = "//flink.apache.org/zh/downloads.html"
+
JavaDocs = "//ci.apache.org/projects/flink/flink-docs-master/api/java/"
ScalaDocs =
"//ci.apache.org/projects/flink/flink-docs-master/api/scala/index.html#org.apache.flink.api.scala.package"
diff --git
a/docs/content.zh/docs/deployment/resource-providers/standalone/overview.md
b/docs/content.zh/docs/deployment/resource-providers/standalone/overview.md
index 9718cf3..d97d64f 100644
--- a/docs/content.zh/docs/deployment/resource-providers/standalone/overview.md
+++ b/docs/content.zh/docs/deployment/resource-providers/standalone/overview.md
@@ -69,7 +69,7 @@ Flink 需要 master 和所有 worker 节点设置 `JAVA_HOME` 环境变量，并
## Flink 设置
-前往 [下载页面]({{ site.zh_download_url }}) 获取可运行的软件包。
+前往 [下载页面]({{< downloads >}}) 获取可运行的软件包。
在下载完最新的发布版本后，复制压缩文件到 master 节点并解压：
diff --git a/docs/content.zh/docs/deployment/resource-providers/yarn.md
b/docs/content.zh/docs/deployment/resource-providers/yarn.md
index 91d7c12..18e135e 100644
--- a/docs/content.zh/docs/deployment/resource-providers/yarn.md
+++ b/docs/content.zh/docs/deployment/resource-providers/yarn.md
@@ -43,7 +43,7 @@ Flink can dynamically allocate and de-allocate TaskManager
resources depending o
This *Getting Started* section assumes a functional YARN environment, starting
from version 2.4.1. YARN environments are provided most conveniently through
services such as Amazon EMR, Google Cloud DataProc or products like Cloudera.
[Manually setting up a YARN environment
locally](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/SingleCluster.html)
or [on a
cluster](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/ClusterSetup.html)
is not [...]
- Make sure your YARN cluster is ready for accepting Flink applications by
running `yarn top`. It should show no error messages.
-- Download a recent Flink distribution from the [download page]({{
site.download_url }}) and unpack it.
+- Download a recent Flink distribution from the [download page]({{< downloads
>}}) and unpack it.
- **Important** Make sure that the `HADOOP_CLASSPATH` environment variable is
set up (it can be checked by running `echo $HADOOP_CLASSPATH`). If not, set it
up using
```bash
@@ -225,7 +225,7 @@ For providing Flink with the required Hadoop dependencies,
we recommend setting
If that is not possible, the dependencies can also be put into the `lib/`
folder of Flink.
-Flink also offers pre-bundled Hadoop fat jars for placing them in the `lib/`
folder, on the [Downloads / Additional
Components]({{site.download_url}}#additional-components) section of the
website. These pre-bundled fat jars are shaded to avoid dependency conflicts
with common libraries. The Flink community is not testing the YARN integration
against these pre-bundled jars.
+Flink also offers pre-bundled Hadoop fat jars for placing them in the `lib/`
folder, on the [Downloads / Additional Components]({{< downloads
>}}#additional-components) section of the website. These pre-bundled fat jars
are shaded to avoid dependency conflicts with common libraries. The Flink
community is not testing the YARN integration against these pre-bundled jars.
### Running Flink on YARN behind Firewalls
diff --git
a/docs/content.zh/docs/dev/datastream/fault-tolerance/queryable_state.md
b/docs/content.zh/docs/dev/datastream/fault-tolerance/queryable_state.md
index 33e81cc..e73ea59 100644
--- a/docs/content.zh/docs/dev/datastream/fault-tolerance/queryable_state.md
+++ b/docs/content.zh/docs/dev/datastream/fault-tolerance/queryable_state.md
@@ -56,7 +56,7 @@ under the License.
为了在 Flink 集群上使用 queryable state，需要进行以下操作：
1. 将 `flink-queryable-state-runtime{{< scala_version >}}-{{< version >}}.jar`
-从 [Flink distribution](https://flink.apache.org/downloads.html "Apache Flink:
Downloads") 的 `opt/` 目录拷贝到 `lib/` 目录；
+从 [Flink distribution]({{< downloads >}} "Apache Flink: Downloads") 的 `opt/`
目录拷贝到 `lib/` 目录；
2. 将参数 `queryable-state.enable` 设置为 `true`。详细信息以及其它配置可参考文档
[Configuration]({{< ref "docs/deployment/config" >}}#queryable-state)。
为了验证集群的 queryable state 已经被激活，可以检查任意 task manager 的日志中是否包含 "Started the
Queryable State Proxy Server @ ..."。
diff --git a/docs/content.zh/docs/flinkDev/building.md
b/docs/content.zh/docs/flinkDev/building.md
index d2a5ce4..61f6b2e 100644
--- a/docs/content.zh/docs/flinkDev/building.md
+++ b/docs/content.zh/docs/flinkDev/building.md
@@ -33,7 +33,7 @@ under the License.
## 构建 Flink
-首先需要准备源码。可以[从发布版本下载源码](https://flink.apache.org/downloads.html) 或者[从 Git 库克隆
Flink 源码]({{< github_repo >}})。
+首先需要准备源码。可以[从发布版本下载源码]({{< downloads >}}) 或者[从 Git 库克隆 Flink 源码]({{<
github_repo >}})。
还需要准备 **Maven 3** 和 **JDK** (Java开发套件)。Flink 依赖 **Java 8** 或更新的版本来进行构建。
diff --git a/docs/content.zh/docs/libs/gelly/overview.md
b/docs/content.zh/docs/libs/gelly/overview.md
index 9ac2124..10716d8 100644
--- a/docs/content.zh/docs/libs/gelly/overview.md
+++ b/docs/content.zh/docs/libs/gelly/overview.md
@@ -60,7 +60,7 @@ The remaining sections provide a description of available
methods and present se
Running Gelly Examples
----------------------
-The Gelly library jars are provided in the [Flink
distribution](https://flink.apache.org/downloads.html "Apache Flink: Downloads")
+The Gelly library jars are provided in the [Flink distribution]({{< downloads
>}} "Apache Flink: Downloads")
in the **opt** directory (for versions older than Flink 1.2 these can be
manually downloaded from
[Maven Central](http://search.maven.org/#search|ga|1|flink%20gelly)). To run
the Gelly examples the **flink-gelly** (for
Java) or **flink-gelly-scala** (for Scala) jar must be copied to Flink's
**lib** directory.
diff --git a/docs/content.zh/docs/try-flink/local_installation.md
b/docs/content.zh/docs/try-flink/local_installation.md
index 19c25b5..783f68e 100644
--- a/docs/content.zh/docs/try-flink/local_installation.md
+++ b/docs/content.zh/docs/try-flink/local_installation.md
@@ -48,7 +48,7 @@ under the License.
java -version
```
-[下载](https://flink.apache.org/downloads.html) release {{< version >}} 并解压。
+[下载]({{< downloads >}}) release {{< version >}} 并解压。
```bash
$ tar -xzf flink-{{< version >}}-bin-scala{{< scala_version >}}.tgz
diff --git a/docs/content.zh/release-notes/flink-1.8.md
b/docs/content.zh/release-notes/flink-1.8.md
index 5e263a3..5d7f251 100644
--- a/docs/content.zh/release-notes/flink-1.8.md
+++ b/docs/content.zh/release-notes/flink-1.8.md
@@ -88,7 +88,7 @@ Convenience binaries that include hadoop are no longer
released.
If a deployment relies on `flink-shaded-hadoop2` being included in
`flink-dist`, then you must manually download a pre-packaged Hadoop
jar from the optional components section of the [download
-page](https://flink.apache.org/downloads.html) and copy it into the
+page]({{< downloads >}}) and copy it into the
`/lib` directory. Alternatively, a Flink distribution that includes
hadoop can be built by packaging `flink-dist` and activating the
`include-hadoop` maven profile.
diff --git
a/docs/content/docs/deployment/resource-providers/standalone/overview.md
b/docs/content/docs/deployment/resource-providers/standalone/overview.md
index c0f2447..a684717 100644
--- a/docs/content/docs/deployment/resource-providers/standalone/overview.md
+++ b/docs/content/docs/deployment/resource-providers/standalone/overview.md
@@ -49,7 +49,7 @@ In the additional subpages of the standalone mode resource
provider, we describe
Flink runs on all *UNIX-like environments*, e.g. **Linux**, **Mac OS X**, and
**Cygwin** (for Windows). Before you start to setup the system, make sure your
system fulfils the following requirements.
- **Java 1.8.x** or higher installed,
-- Downloaded a recent Flink distribution from the [download page]({{
site.download_url }}) and unpacked it.
+- Downloaded a recent Flink distribution from the [download page]({{<
downloads >}}) and unpacked it.
### Starting a Standalone Cluster (Session Mode)
diff --git a/docs/content/docs/deployment/resource-providers/yarn.md
b/docs/content/docs/deployment/resource-providers/yarn.md
index dc1ed14..03acbf7 100644
--- a/docs/content/docs/deployment/resource-providers/yarn.md
+++ b/docs/content/docs/deployment/resource-providers/yarn.md
@@ -38,12 +38,14 @@ Flink services are submitted to YARN's ResourceManager,
which spawns containers
Flink can dynamically allocate and de-allocate TaskManager resources depending
on the number of processing slots required by the job(s) running on the
JobManager.
+ [测试]({{< downloads >}})
+
### Preparation
This *Getting Started* section assumes a functional YARN environment, starting
from version 2.4.1. YARN environments are provided most conveniently through
services such as Amazon EMR, Google Cloud DataProc or products like Cloudera.
[Manually setting up a YARN environment
locally](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/SingleCluster.html)
or [on a
cluster](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/ClusterSetup.html)
is not [...]
- Make sure your YARN cluster is ready for accepting Flink applications by
running `yarn top`. It should show no error messages.
-- Download a recent Flink distribution from the [download page]({{
site.download_url }}) and unpack it.
+- Download a recent Flink distribution from the [download page]({{< downloads
>}}) and unpack it.
- **Important** Make sure that the `HADOOP_CLASSPATH` environment variable is
set up (it can be checked by running `echo $HADOOP_CLASSPATH`). If not, set it
up using
```bash
@@ -225,7 +227,7 @@ For providing Flink with the required Hadoop dependencies,
we recommend setting
If that is not possible, the dependencies can also be put into the `lib/`
folder of Flink.
-Flink also offers pre-bundled Hadoop fat jars for placing them in the `lib/`
folder, on the [Downloads / Additional
Components]({{site.download_url}}#additional-components) section of the
website. These pre-bundled fat jars are shaded to avoid dependency conflicts
with common libraries. The Flink community is not testing the YARN integration
against these pre-bundled jars.
+Flink also offers pre-bundled Hadoop fat jars for placing them in the `lib/`
folder, on the [Downloads / Additional Components]({{< downloads
>}}#additional-components) section of the website. These pre-bundled fat jars
are shaded to avoid dependency conflicts with common libraries. The Flink
community is not testing the YARN integration against these pre-bundled jars.
### Running Flink on YARN behind Firewalls
diff --git
a/docs/content/docs/dev/datastream/fault-tolerance/queryable_state.md
b/docs/content/docs/dev/datastream/fault-tolerance/queryable_state.md
index c243c43..66d47c0 100644
--- a/docs/content/docs/dev/datastream/fault-tolerance/queryable_state.md
+++ b/docs/content/docs/dev/datastream/fault-tolerance/queryable_state.md
@@ -72,7 +72,7 @@ response back to the client.
To enable queryable state on your Flink cluster, you need to do the following:
1. copy the `flink-queryable-state-runtime{{< scala_version >}}-{{< version
>}}.jar`
-from the `opt/` folder of your [Flink
distribution](https://flink.apache.org/downloads.html "Apache Flink:
Downloads"),
+from the `opt/` folder of your [Flink distribution]({{< downloads >}} "Apache
Flink: Downloads"),
to the `lib/` folder.
2. set the property `queryable-state.enable` to `true`. See the
[Configuration]({{< ref "docs/deployment/config" >}}#queryable-state)
documentation for details and additional parameters.
diff --git a/docs/content/docs/flinkDev/building.md
b/docs/content/docs/flinkDev/building.md
index 5b43e16..b656601 100644
--- a/docs/content/docs/flinkDev/building.md
+++ b/docs/content/docs/flinkDev/building.md
@@ -31,7 +31,7 @@ This page covers how to build Flink {{< version >}} from
sources.
## Build Flink
-In order to build Flink you need the source code. Either [download the source
of a release](https://flink.apache.org/downloads.html) or [clone the git
repository]({{< github_repo >}}).
+In order to build Flink you need the source code. Either [download the source
of a release]({{< downloads >}}) or [clone the git repository]({{< github_repo
>}}).
In addition you need **Maven 3** and a **JDK** (Java Development Kit). Flink
requires **at least Java 8** to build.
diff --git a/docs/content/docs/libs/gelly/overview.md
b/docs/content/docs/libs/gelly/overview.md
index 35326a2..65ef293 100644
--- a/docs/content/docs/libs/gelly/overview.md
+++ b/docs/content/docs/libs/gelly/overview.md
@@ -60,7 +60,7 @@ The remaining sections provide a description of available
methods and present se
Running Gelly Examples
----------------------
-The Gelly library jars are provided in the [Flink
distribution](https://flink.apache.org/downloads.html "Apache Flink: Downloads")
+The Gelly library jars are provided in the [Flink distribution]({{< downloads
>}} "Apache Flink: Downloads")
in the **opt** directory (for versions older than Flink 1.2 these can be
manually downloaded from
[Maven Central](http://search.maven.org/#search|ga|1|flink%20gelly)). To run
the Gelly examples the **flink-gelly** (for
Java) or **flink-gelly-scala** (for Scala) jar must be copied to Flink's
**lib** directory.
diff --git a/docs/content/docs/try-flink/local_installation.md
b/docs/content/docs/try-flink/local_installation.md
index a08bd85..e61e8dc 100644
--- a/docs/content/docs/try-flink/local_installation.md
+++ b/docs/content/docs/try-flink/local_installation.md
@@ -46,7 +46,7 @@ to have __Java 8 or 11__ installed. To check the Java version
installed, type in
$ java -version
```
-Next, [download the latest binary
release](https://flink.apache.org/downloads.html) of Flink,
+Next, [download the latest binary release]({{< downloads >}}) of Flink,
then extract the archive:
```bash
diff --git a/docs/content/release-notes/flink-1.8.md
b/docs/content/release-notes/flink-1.8.md
index 5e263a3..5d7f251 100644
--- a/docs/content/release-notes/flink-1.8.md
+++ b/docs/content/release-notes/flink-1.8.md
@@ -88,7 +88,7 @@ Convenience binaries that include hadoop are no longer
released.
If a deployment relies on `flink-shaded-hadoop2` being included in
`flink-dist`, then you must manually download a pre-packaged Hadoop
jar from the optional components section of the [download
-page](https://flink.apache.org/downloads.html) and copy it into the
+page]({{< downloads >}}) and copy it into the
`/lib` directory. Alternatively, a Flink distribution that includes
hadoop can be built by packaging `flink-dist` and activating the
`include-hadoop` maven profile.
diff --git a/docs/layouts/shortcodes/downloads.html
b/docs/layouts/shortcodes/downloads.html
new file mode 100644
index 0000000..5fb19d9
--- /dev/null
+++ b/docs/layouts/shortcodes/downloads.html
@@ -0,0 +1,28 @@
+{{/*
+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.
+*/}}{{/*
+ Shortcode for linking to Flink's download page.
+
+ This way the English and Chinese docs will always point to the correct
page.
+
+*/}}
+{{ if eq "/zh" .Site.LanguagePrefix }}
+ {{ .Site.Params.ZhDownloadPage }}
+{{ else }}
+ {{ .Site.Params.DownloadPage }}
+{{ end }}
