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/22 10:14:10 UTC
[1/2] flink git commit: [FLINK-6985] [docs] Remove bugfix version
from title
Repository: flink
Updated Branches:
refs/heads/master 87e1e8fc3 -> 02877580a
[FLINK-6985] [docs] Remove bugfix version from title
Removes the bugfix version from title and other places where it
can potentially be confusing.
For snapshot release, version and version_short should be the
same, e.g. 1.4-SNAPSHOT. For stable releases, version should be
the full version string (e.g. 1.2.1) whereas version_short
should skip the bugfix version (e.g. 1.2):.
This closes #4162.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/02877580
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/02877580
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/02877580
Branch: refs/heads/master
Commit: 02877580a30d54344e085ab00d2fd599fc895c45
Parents: e7c887c
Author: Ufuk Celebi <uc...@apache.org>
Authored: Thu Jun 22 11:37:54 2017 +0200
Committer: Ufuk Celebi <uc...@apache.org>
Committed: Thu Jun 22 12:14:03 2017 +0200
----------------------------------------------------------------------
docs/_config.yml | 5 ++++-
docs/_includes/sidenav.html | 2 +-
docs/_layouts/base.html | 2 +-
docs/index.md | 2 +-
4 files changed, 7 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/02877580/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index cf5ee10..40a2bb5 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -26,8 +26,11 @@
# to reference a specific Flink version, because this is the only place where
# we change the version for the complete docs when forking of a release branch
# etc.
+# The full version string as referenced in Maven (e.g. 1.2.1)
version: "1.4-SNAPSHOT"
-version_short: "1.4" # Used for the top navbar w/o snapshot suffix
+# 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
# This suffix is appended to the Scala-dependent Maven artifact names
http://git-wip-us.apache.org/repos/asf/flink/blob/02877580/docs/_includes/sidenav.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
index 9a49484..89e79ad 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 }}</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_short }}</p>
</div>
<ul id="sidenav">
{% for i in (1..10000) %}
http://git-wip-us.apache.org/repos/asf/flink/blob/02877580/docs/_layouts/base.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 88df5c9..6b26ea4 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}} Documentation: {{ page.title }}</title>
+ <title>Apache Flink {{ site.version_short }} 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/02877580/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index ef9317f..646694b 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 }}. These pages have been built at: {% build_time %}.
+This documentation is for Apache Flink version {{ site.version_short }}. 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.
[2/2] flink git commit: [FLINK-6952] [docs] Add link to Javadocs
Posted by uc...@apache.org.
[FLINK-6952] [docs] Add link to Javadocs
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/e7c887c0
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/e7c887c0
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/e7c887c0
Branch: refs/heads/master
Commit: e7c887c00333af195c079c0d9a727249053d9871
Parents: 87e1e8f
Author: Ufuk Celebi <uc...@apache.org>
Authored: Tue Jun 20 12:19:07 2017 +0200
Committer: Ufuk Celebi <uc...@apache.org>
Committed: Thu Jun 22 12:14:03 2017 +0200
----------------------------------------------------------------------
docs/_includes/sidenav.html | 1 +
1 file changed, 1 insertion(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/e7c887c0/docs/_includes/sidenav.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
index e3bb2d7..9a49484 100644
--- a/docs/_includes/sidenav.html
+++ b/docs/_includes/sidenav.html
@@ -126,6 +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="http://flink.apache.org"><i class="fa fa-external-link title" aria-hidden="true"></i> Project Page</a></li>
</ul>