[flink] branch master updated: Fix Javadoc links in documentation

[al...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

aljoscha 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 047a85b  Fix Javadoc links in documentation
047a85b is described below

commit 047a85bc4542ca92fda4fb96ae5faecdd5758291
Author: Aljoscha Krettek <al...@gmail.com>
AuthorDate: Fri Aug 10 12:11:32 2018 +0200

    Fix Javadoc links in documentation
    
    Previously, it was pointing to release-1.7-SNAPSHOT where we don't
    actually serve javadocs.
    
    Now we always point to master and have a dedicated variable for this so
    it can easily changed on release branches.
---
 docs/_config.yml                         | 4 ++--
 docs/_includes/sidenav.html              | 4 ++--
 tools/releasing/create_release_branch.sh | 2 --
 tools/releasing/update_branch_version.sh | 2 --
 4 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/docs/_config.yml b/docs/_config.yml
index 48f3957..79c4070 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -31,8 +31,6 @@ version: "1.7-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_title: "1.7-SNAPSHOT"
-version_javadocs: "1.7-SNAPSHOT"
-version_scaladocs: "1.7-SNAPSHOT"
 
 # This suffix is appended to the Scala-dependent Maven artifact names
 scala_version_suffix: "_2.11"
@@ -48,6 +46,8 @@ download_url: "http://flink.apache.org/downloads.html"
 baseurl: //ci.apache.org/projects/flink/flink-docs-master
 stable_baseurl: //ci.apache.org/projects/flink/flink-docs-stable
 
+javadocs_baseurl: //ci.apache.org/projects/flink/flink-docs-master
+
 # Flag whether this is a stable version or not. Used for the quickstart page.
 is_stable: false
 
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
index 5e50c35..5c5fb51 100644
--- a/docs/_includes/sidenav.html
+++ b/docs/_includes/sidenav.html
@@ -126,8 +126,8 @@ 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_javadocs}}/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_scaladocs}}/api/scala/index.html#org.apache.flink.api.scala.package"><i class="fa fa-external-link title" aria-hidden="true"></i> Scaladocs</a></li>
+  <li><a href="{{ site.javadocs_baseurl }}/api/java"><i class="fa fa-external-link title" aria-hidden="true"></i> Javadocs</a></li>
+  <li><a href="{{ site.javadocs_baseurl }}/api/scala/index.html#org.apache.flink.api.scala.package"><i class="fa fa-external-link title" aria-hidden="true"></i> Scaladocs</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>
 
diff --git a/tools/releasing/create_release_branch.sh b/tools/releasing/create_release_branch.sh
index 7e16483..615722b 100755
--- a/tools/releasing/create_release_branch.sh
+++ b/tools/releasing/create_release_branch.sh
@@ -66,8 +66,6 @@ perl -pi -e "s#^version: .*#version: \"${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
-perl -pi -e "s#^version_scaladocs: .*#version_scaladocs: ${VERSION_TITLE}#" _config.yml
 cd ..
 
 git commit -am "Commit for release $NEW_VERSION"
diff --git a/tools/releasing/update_branch_version.sh b/tools/releasing/update_branch_version.sh
index 951ea71..90fd782 100755
--- a/tools/releasing/update_branch_version.sh
+++ b/tools/releasing/update_branch_version.sh
@@ -55,8 +55,6 @@ find . -name 'pom.xml' -type f -exec perl -pi -e 's#<version>'$OLD_VERSION'</ver
 cd docs
 perl -pi -e "s#^version: .*#version: \"${NEW_VERSION}\"#" _config.yml
 perl -pi -e "s#^version_title: .*#version_title: \"${NEW_VERSION}\"#" _config.yml
-perl -pi -e "s#^version_javadocs: .*#version_javadocs: \"${NEW_VERSION}\"#" _config.yml
-perl -pi -e "s#^version_scaladocs: .*#version_scaladocs: \"${NEW_VERSION}\"#" _config.yml
 cd ..
 
 git commit -am "Update version to $NEW_VERSION"