Repository: flink Updated Branches: refs/heads/master 80b570be5 -> 91102695b
[FLINK-1800] [docs] Add beta tag to components in flink-staging This closes #555. Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/91102695 Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/91102695 Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/91102695 Branch: refs/heads/master Commit: 91102695bfe60bf6da896f48980c15af6742d3a0 Parents: 80b570b Author: Robert Metzger <[email protected]> Authored: Wed Apr 1 12:19:27 2015 +0200 Committer: Ufuk Celebi <[email protected]> Committed: Thu Apr 9 15:30:28 2015 +0200 ---------------------------------------------------------------------- docs/_includes/navbar.html | 3 +-- docs/_includes/sidenav.html | 12 +++++++----- docs/_layouts/default.html | 2 +- docs/gelly_guide.md | 1 + docs/hadoop_compatibility.md | 2 ++ docs/streaming_guide.md | 1 + docs/table.md | 1 + 7 files changed, 14 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/91102695/docs/_includes/navbar.html ---------------------------------------------------------------------- diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html index 7f02439..8600541 100644 --- a/docs/_includes/navbar.html +++ b/docs/_includes/navbar.html @@ -42,7 +42,7 @@ under the License. </div> </div> </div> - </div> + </div> <!-- Navigation --> <div class="col-md-11"> <div class="collapse navbar-collapse" id="navbar-collapse-1"> @@ -59,7 +59,6 @@ under the License. <li> <a href="{{ site.baseurl }}/api/scala/index.html#org.apache.flink.api.scala.package">Scaladoc</a> </li> - </ul> </div> </div> http://git-wip-us.apache.org/repos/asf/flink/blob/91102695/docs/_includes/sidenav.html ---------------------------------------------------------------------- diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html index 5bdbc0d..b21eaee 100644 --- a/docs/_includes/sidenav.html +++ b/docs/_includes/sidenav.html @@ -36,13 +36,13 @@ under the License. <li><div class="sidenav-item"><a href="{{ site.baseurl }}/programming_guide.html">Programming Guide</a></div></li> <li><div class="sidenav-item"><a href="{{ site.baseurl }}/dataset_transformations.html">DataSet Transformations</a></div></li> <li><div class="sidenav-item"><a href="{{ site.baseurl }}/java8_programming_guide.html">Java 8 Programming Guide</a></div></li> - <li><div class="sidenav-item"><a href="{{ site.baseurl }}/streaming_guide.html">Streaming Guide</a></div></li> + <li><div class="sidenav-item"><a href="{{ site.baseurl }}/streaming_guide.html">Streaming Guide</a> <small>Beta</small></div></li> <li><div class="sidenav-item"><a href="{{ site.baseurl }}/iterations.html">Iterations</a></div></li> <li><div class="sidenav-item"><a href="{{ site.baseurl }}/spargel_guide.html">Spargel Graph API</a></div></li> - <li><div class="sidenav-item"><a href="{{ site.baseurl }}/gelly_guide.html">Gelly Graph API</a></div></li> - <li><div class="sidenav-item"><a href="{{ site.baseurl }}/table.html">Table API - Relational Queries</a></div></li> - <li><div class="sidenav-item"><a href="{{ site.baseurl }}/hadoop_compatibility.html">Hadoop Compatibility</a></div></li> - <li><div class="sidenav-item-bottom"><a href="{{ site.baseurl }}/flink_on_tez_guide.html">Running Flink on Tez</a></div></li> + <li><div class="sidenav-item"><a href="{{ site.baseurl }}/gelly_guide.html">Gelly Graph API</a> <small>Beta</small></div></li> + <li><div class="sidenav-item"><a href="{{ site.baseurl }}/table.html">Table API - Relational Queries</a> <small>Beta</small></div></li> + <li><div class="sidenav-item"><a href="{{ site.baseurl }}/hadoop_compatibility.html">Hadoop Compatibility</a> <small>Beta</small></div></li> + <li><div class="sidenav-item-bottom"><a href="{{ site.baseurl }}/flink_on_tez_guide.html">Running Flink on Tez</a> <small>Beta</small></div></li> <li><div class="sidenav-category">Examples</div></li> <li><div class="sidenav-item"><a href="{{ site.baseurl }}/examples.html">Bundled Examples</a></div></li> @@ -66,3 +66,5 @@ under the License. <!-- <li><a href=#">Program Optimizer</a></li> --> <li><div class="sidenav-item-bottom"><a href="{{ site.baseurl }}/internal_howto.html">Developer How-To's</a></div></li> </ul> + +<small>Components marked with <strong>Beta</strong> have been added to Flink recently. They are under heavy development and might be incomplete or unstable.</small> http://git-wip-us.apache.org/repos/asf/flink/blob/91102695/docs/_layouts/default.html ---------------------------------------------------------------------- diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index bc6f433..051b44f 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -54,7 +54,7 @@ under the License. {% include sidenav.html %} </div> <div class="col-md-9"> - <h1>{{ page.title }}</h1> + <h1>{{ page.title }}{% if page.is_beta == true %} <span class="badge">Beta</span>{% endif %}</h1> {{ content }} http://git-wip-us.apache.org/repos/asf/flink/blob/91102695/docs/gelly_guide.md ---------------------------------------------------------------------- diff --git a/docs/gelly_guide.md b/docs/gelly_guide.md index 7031550..9cceafc 100644 --- a/docs/gelly_guide.md +++ b/docs/gelly_guide.md @@ -1,5 +1,6 @@ --- title: "Gelly: Flink Graph API" +is_beta: true --- <!-- Licensed to the Apache Software Foundation (ASF) under one http://git-wip-us.apache.org/repos/asf/flink/blob/91102695/docs/hadoop_compatibility.md ---------------------------------------------------------------------- diff --git a/docs/hadoop_compatibility.md b/docs/hadoop_compatibility.md index cacca0f..92981b7 100644 --- a/docs/hadoop_compatibility.md +++ b/docs/hadoop_compatibility.md @@ -1,5 +1,6 @@ --- title: "Hadoop Compatibility" +is_beta: true --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -20,6 +21,7 @@ specific language governing permissions and limitations under the License. --> + * This will be replaced by the TOC {:toc} http://git-wip-us.apache.org/repos/asf/flink/blob/91102695/docs/streaming_guide.md ---------------------------------------------------------------------- diff --git a/docs/streaming_guide.md b/docs/streaming_guide.md index 80a9959..2b7f360 100644 --- a/docs/streaming_guide.md +++ b/docs/streaming_guide.md @@ -1,5 +1,6 @@ --- title: "Flink Stream Processing API" +is_beta: true --- <!-- Licensed to the Apache Software Foundation (ASF) under one http://git-wip-us.apache.org/repos/asf/flink/blob/91102695/docs/table.md ---------------------------------------------------------------------- diff --git a/docs/table.md b/docs/table.md index 55f989b..d11d905 100644 --- a/docs/table.md +++ b/docs/table.md @@ -1,5 +1,6 @@ --- title: "Table API - Relational Queries" +is_beta: true --- <!-- Licensed to the Apache Software Foundation (ASF) under one
