You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by uc...@apache.org on 2017/06/23 08:16:45 UTC
flink git commit: [FLINK-6952, FLINK-6985] [docs] Fix Javadocs links
Repository: flink
Updated Branches:
refs/heads/master 02877580a -> 44ae21d7e
[FLINK-6952, FLINK-6985] [docs] Fix Javadocs links
This is a follow up to e7c887c and 0287758. For snapshot versions
we need to differntiate between title version and javadocs version.
In addition, this removes an unneded config variable and updates
the release scripts.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/44ae21d7
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/44ae21d7
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/44ae21d7
Branch: refs/heads/master
Commit: 44ae21d7e33da2ccebdab7ca460629759a381a6b
Parents: 0287758
Author: Ufuk Celebi <uc...@apache.org>
Authored: Fri Jun 23 10:12:23 2017 +0200
Committer: Ufuk Celebi <uc...@apache.org>
Committed: Fri Jun 23 10:12:24 2017 +0200
----------------------------------------------------------------------
docs/_config.yml | 4 ++--
docs/_includes/sidenav.html | 4 ++--
docs/_layouts/base.html | 2 +-
docs/index.md | 2 +-
tools/create_release_files.sh | 6 +++++-
5 files changed, 11 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/44ae21d7/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 40a2bb5..e4d9f0a 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -30,8 +30,8 @@
version: "1.4-SNAPSHOT"
# For stable releases, leave the bugfix version out (e.g. 1.2). For snapshot
# release this should be the same as the regular version
-version_short: "1.4-SNAPSHOT"
-is_snapshot_version: true
+version_title: "1.4-SNAPSHOT"
+version_javadocs: "1.4"
# This suffix is appended to the Scala-dependent Maven artifact names
scala_version_suffix: "_2.10"
http://git-wip-us.apache.org/repos/asf/flink/blob/44ae21d7/docs/_includes/sidenav.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
index 89e79ad..fc9c1b6 100644
--- a/docs/_includes/sidenav.html
+++ b/docs/_includes/sidenav.html
@@ -72,7 +72,7 @@ level is determined by 'nav-pos'.
{% assign pos = 0 %}
<div class="sidenav-logo">
- <p><a href="{{ site.baseurl }}"><img class="bottom" alt="Apache Flink" src="{{ site.baseurl }}/page/img/navbar-brand-logo.jpg"></a> v{{ site.version_short }}</p>
+ <p><a href="{{ site.baseurl }}"><img class="bottom" alt="Apache Flink" src="{{ site.baseurl }}/page/img/navbar-brand-logo.jpg"></a> v{{ site.version_title }}</p>
</div>
<ul id="sidenav">
{% for i in (1..10000) %}
@@ -126,7 +126,7 @@ level is determined by 'nav-pos'.
{% endif %}
{% endfor %}
<li class="divider"></li>
- <li><a href="https://ci.apache.org/projects/flink/flink-docs-release-{{site.version_short}}/api/java"><i class="fa fa-external-link title" aria-hidden="true"></i> Javadocs</a></li>
+ <li><a href="https://ci.apache.org/projects/flink/flink-docs-release-{{site.version_javadocs}}/api/java"><i class="fa fa-external-link title" aria-hidden="true"></i> Javadocs</a></li>
<li><a href="http://flink.apache.org"><i class="fa fa-external-link title" aria-hidden="true"></i> Project Page</a></li>
</ul>
http://git-wip-us.apache.org/repos/asf/flink/blob/44ae21d7/docs/_layouts/base.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 6b26ea4..d51451a 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -23,7 +23,7 @@ under the License.
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
- <title>Apache Flink {{ site.version_short }} Documentation: {{ page.title }}</title>
+ <title>Apache Flink {{ site.version_title }} Documentation: {{ page.title }}</title>
<link rel="shortcut icon" href="{{ site.baseurl }}/page/favicon.ico" type="image/x-icon">
<link rel="icon" href="{{ site.baseurl }}/page/favicon.ico" type="image/x-icon">
http://git-wip-us.apache.org/repos/asf/flink/blob/44ae21d7/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 646694b..ae3979d 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -25,7 +25,7 @@ under the License.
-This documentation is for Apache Flink version {{ site.version_short }}. These pages have been built at: {% build_time %}.
+This documentation is for Apache Flink version {{ site.version_title }}. These pages have been built at: {% build_time %}.
Apache Flink is an open source platform for distributed stream and batch data processing. Flink’s core is a streaming dataflow engine that provides data distribution, communication, and fault tolerance for distributed computations over data streams. Flink also builds batch processing on top of the streaming engine, overlaying native iteration support, managed memory, and program optimization.
http://git-wip-us.apache.org/repos/asf/flink/blob/44ae21d7/tools/create_release_files.sh
----------------------------------------------------------------------
diff --git a/tools/create_release_files.sh b/tools/create_release_files.sh
index ba99846..663b634 100755
--- a/tools/create_release_files.sh
+++ b/tools/create_release_files.sh
@@ -181,7 +181,11 @@ make_source_release() {
#change version of documentation
cd docs
perl -pi -e "s#^version: .*#version: ${NEW_VERSION}#" _config.yml
- perl -pi -e "s#^version_short: .*#version_short: ${NEW_VERSION}#" _config.yml
+
+ # The version in the title should not contain the bugfix version (e.g. 1.3)
+ VERSION_TITLE=$(echo $NEW_VERSION | sed 's/\.[^.]*$//')
+ perl -pi -e "s#^version_title: .*#version_title: ${VERSION_TITLE}#" _config.yml
+ perl -pi -e "s#^version_javadocs: .*#version_javadocs: ${VERSION_TITLE}#" _config.yml
cd ..
# local dist have no need to commit to remote