Skip to content

Commit

Permalink
[FLINK-6952, FLINK-6985] [docs] Fix Javadocs links
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
uce committed Jun 23, 2017
1 parent 0287758 commit 44ae21d
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions 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_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) %}
Expand Down Expand Up @@ -126,7 +126,7 @@
{% 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>

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_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">

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_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.

Expand Down
6 changes: 5 additions & 1 deletion tools/create_release_files.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 44ae21d

Please sign in to comment.