flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From twal...@apache.org
Subject flink git commit: [FLINK-7462] [docs] Add very obvious warning about outdated docs
Date Thu, 17 Aug 2017 05:07:18 GMT
Repository: flink
Updated Branches:
  refs/heads/release-1.2 85f53b2a0 -> 4b2186925


[FLINK-7462] [docs] Add very obvious warning about outdated docs

This closes #4553.


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/4b218692
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/4b218692
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/4b218692

Branch: refs/heads/release-1.2
Commit: 4b218692513dae415a2e90971c63e4a9c002fba6
Parents: 85f53b2
Author: Ufuk Celebi <uce@apache.org>
Authored: Wed Aug 16 18:21:49 2017 +0200
Committer: twalthr <twalthr@apache.org>
Committed: Thu Aug 17 07:04:17 2017 +0200

----------------------------------------------------------------------
 docs/_config.yml         | 7 ++++---
 docs/_layouts/base.html  | 6 ++----
 docs/_layouts/plain.html | 5 +++++
 3 files changed, 11 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/4b218692/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 34fd7c6..8ab70f3 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -43,11 +43,12 @@ jira_url: "https://issues.apache.org/jira/browse/FLINK"
 github_url: "https://github.com/apache/flink"
 download_url: "http://flink.apache.org/downloads.html"
 
-# Flag whether this is the latest stable version or not. If not, a warning
-# will be printed pointing to the docs of the latest stable version.
-is_latest: false
+# Flag whether this is a stable version or not. Used for the quickstart page.
 is_stable: true
 
+# Flag to indicate whether an outdated warning should be shown.
+show_outdated_warning: true
+
 previous_docs:
   1.1: http://ci.apache.org/projects/flink/flink-docs-release-1.1
   1.0: http://ci.apache.org/projects/flink/flink-docs-release-1.0

http://git-wip-us.apache.org/repos/asf/flink/blob/4b218692/docs/_layouts/base.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 66e3a14..e29e3a9 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -54,12 +54,10 @@ under the License.
     <![endif]-->
   </head>
   <body>
-    {% if site.is_stable %}
-    {% unless site.is_latest %}
-    <div style="position:fixed; bottom:0; left:0; z-index:99999; width:100%; text-align:center;
padding:15px; border-top:1px dashed #CE4B65; background:#f6f0e3; font-weight:bold">
+    {% if site.show_outdated_warning %}
+    <div style="position:fixed; bottom:0; left:0; z-index:99999; width:100%; text-align:center;
padding:15px; border-top:5px solid #ECCCD1; background:#F2DEDE; color:#AD433F; font-weight:bold">
        This documentation is for an out-of-date version of Apache Flink. We recommend you
use <a href="https://flink.apache.org/q/stable-docs.html">the latest stable version</a>.
     </div>
-    {% endunless %}
     {% endif %}
 
     <!-- Main content. -->

http://git-wip-us.apache.org/repos/asf/flink/blob/4b218692/docs/_layouts/plain.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/plain.html b/docs/_layouts/plain.html
index 63a6681..e991f78 100644
--- a/docs/_layouts/plain.html
+++ b/docs/_layouts/plain.html
@@ -53,5 +53,10 @@ under the License.
 </ol>
 
 <h1>{{ page.title }}{% if page.is_beta %} <span class="beta">Beta</span>{%
endif %}</h1>
+{% if site.show_outdated_warning %}
+<div class="alert alert-danger" role="alert">
+  <strong>This documentation is for an out-of-date version of Apache Flink. We recommend
you use <a href="https://flink.apache.org/q/stable-docs.html">the latest stable version</a>.</strong>
+</div>
+{% endif %}
 
 {{ content }}


Mime
View raw message