Skip to content

Commit

Permalink
[FLINK-6985] [docs] Remove bugfix version from title
Browse files Browse the repository at this point in the history
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 apache#4162.
  • Loading branch information
uce committed Jun 22, 2017
1 parent e7c887c commit 0287758
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
5 changes: 4 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/_includes/sidenav.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
{% 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) %}
Expand Down
2 changes: 1 addition & 1 deletion docs/_layouts/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<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">

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 0287758

Please sign in to comment.