You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by gu...@apache.org on 2017/11/15 22:43:18 UTC
kafka git commit: MINOR: Adding secondary nav to Streams webpage
Repository: kafka
Updated Branches:
refs/heads/trunk dc2322a27 -> ca7f3dab0
MINOR: Adding secondary nav to Streams webpage
Added secondary navigation to Streams sub-pages:
- quickstart.html
- core-concepts.html
- developer-guide.html
- tutorial.html
Author: Manjula K <ma...@kafka-summit.org>
Reviewers: Joel Hamill <jo...@users.noreply.github.com>, Guozhang Wang <wa...@gmail.com>
Closes #4222 from manjuapu/streams-nav
Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/ca7f3dab
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/ca7f3dab
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/ca7f3dab
Branch: refs/heads/trunk
Commit: ca7f3dab0485158cf91b20d8a4b7164dbcdd3a64
Parents: dc2322a
Author: Manjula K <ma...@kafka-summit.org>
Authored: Wed Nov 15 14:43:11 2017 -0800
Committer: Guozhang Wang <wa...@gmail.com>
Committed: Wed Nov 15 14:43:11 2017 -0800
----------------------------------------------------------------------
docs/streams/core-concepts.html | 28 +++++++++++++++++++++++++++-
docs/streams/developer-guide.html | 27 ++++++++++++++++++++++++++-
docs/streams/quickstart.html | 28 +++++++++++++++++++++++++++-
docs/streams/tutorial.html | 27 ++++++++++++++++++++++++++-
4 files changed, 106 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kafka/blob/ca7f3dab/docs/streams/core-concepts.html
----------------------------------------------------------------------
diff --git a/docs/streams/core-concepts.html b/docs/streams/core-concepts.html
index baf8d9b..dbc3f21 100644
--- a/docs/streams/core-concepts.html
+++ b/docs/streams/core-concepts.html
@@ -19,7 +19,17 @@
<script id="content-template" type="text/x-handlebars-template">
<h1>Core Concepts</h1>
-
+ <div class="sub-nav-sticky">
+ <div class="sticky-top">
+ <div style="height:35px">
+ <a href="/{{version}}/documentation/streams/">Introduction</a>
+ <a href="/{{version}}/documentation/streams/developer-guide">Developer Guide</a>
+ <a class="active-menu-item" href="/{{version}}/documentation/streams/core-concepts">Concepts</a>
+ <a href="/{{version}}/documentation/streams/quickstart">Run Demo App</a>
+ <a href="/{{version}}/documentation/streams/tutorial">Tutorial: Write App</a>
+ </div>
+ </div>
+ </div>
<p>
Kafka Streams is a client library for processing and analyzing data stored in Kafka.
It builds upon important stream processing concepts such as properly distinguishing between event time and processing time, windowing support, and simple yet efficient management and real-time querying of application state.
@@ -181,6 +191,22 @@ $(function() {
// Show selected style on nav item
$('.b-nav__streams').addClass('selected');
+
+ //sticky secondary nav
+ var $navbar = $(".sub-nav-sticky"),
+ y_pos = $navbar.offset().top,
+ height = $navbar.height();
+
+ $(window).scroll(function() {
+ var scrollTop = $(window).scrollTop();
+
+ if (scrollTop > y_pos - height) {
+ $navbar.addClass("navbar-fixed")
+ } else if (scrollTop <= y_pos) {
+ $navbar.removeClass("navbar-fixed")
+ }
+ });
+
// Display docs subnav items
$('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
});
http://git-wip-us.apache.org/repos/asf/kafka/blob/ca7f3dab/docs/streams/developer-guide.html
----------------------------------------------------------------------
diff --git a/docs/streams/developer-guide.html b/docs/streams/developer-guide.html
index eba20a9..5730f53 100644
--- a/docs/streams/developer-guide.html
+++ b/docs/streams/developer-guide.html
@@ -19,7 +19,17 @@
<script id="content-template" type="text/x-handlebars-template">
<h1>Developer Guide for Kafka Streams API</h1>
-
+ <div class="sub-nav-sticky">
+ <div class="sticky-top">
+ <div style="height:35px">
+ <a href="/{{version}}/documentation/streams/">Introduction</a>
+ <a class="active-menu-item" href="/{{version}}/documentation/streams/developer-guide">Developer Guide</a>
+ <a href="/{{version}}/documentation/streams/core-concepts">Concepts</a>
+ <a href="/{{version}}/documentation/streams/quickstart">Run Demo App</a>
+ <a href="/{{version}}/documentation/streams/tutorial">Tutorial: Write App</a>
+ </div>
+ </div>
+ </div>
<p>
This developer guide describes how to write, configure, and execute a Kafka Streams application. There is a <a href="/{{version}}/documentation/#quickstart_kafkastreams">quickstart</a> example that provides how to run a stream processing program coded in the Kafka Streams library.
</p>
@@ -2995,6 +3005,21 @@ $(function() {
// Show selected style on nav item
$('.b-nav__streams').addClass('selected');
+ //sticky secondary nav
+ var $navbar = $(".sub-nav-sticky"),
+ y_pos = $navbar.offset().top,
+ height = $navbar.height();
+
+ $(window).scroll(function() {
+ var scrollTop = $(window).scrollTop();
+
+ if (scrollTop > y_pos - height) {
+ $navbar.addClass("navbar-fixed")
+ } else if (scrollTop <= y_pos) {
+ $navbar.removeClass("navbar-fixed")
+ }
+ });
+
// Display docs subnav items
$('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
});
http://git-wip-us.apache.org/repos/asf/kafka/blob/ca7f3dab/docs/streams/quickstart.html
----------------------------------------------------------------------
diff --git a/docs/streams/quickstart.html b/docs/streams/quickstart.html
index c4b52ea..314bce3 100644
--- a/docs/streams/quickstart.html
+++ b/docs/streams/quickstart.html
@@ -19,7 +19,17 @@
<script id="content-template" type="text/x-handlebars-template">
<h1>Run Streams Demo Application</h1>
-
+ <div class="sub-nav-sticky">
+ <div class="sticky-top">
+ <div style="height:35px">
+ <a href="/{{version}}/documentation/streams/">Introduction</a>
+ <a href="/{{version}}/documentation/streams/developer-guide">Developer Guide</a>
+ <a href="/{{version}}/documentation/streams/core-concepts">Concepts</a>
+ <a class="active-menu-item" href="/{{version}}/documentation/streams/quickstart">Run Demo App</a>
+ <a href="/{{version}}/documentation/streams/tutorial">Tutorial: Write App</a>
+ </div>
+ </div>
+ </div>
<p>
This tutorial assumes you are starting fresh and have no existing Kafka or ZooKeeper data. However, if you have already started Kafka and
ZooKeeper, feel free to skip the first two steps.
@@ -355,6 +365,22 @@ $(function() {
// Show selected style on nav item
$('.b-nav__streams').addClass('selected');
+
+ //sticky secondary nav
+ var $navbar = $(".sub-nav-sticky"),
+ y_pos = $navbar.offset().top,
+ height = $navbar.height();
+
+ $(window).scroll(function() {
+ var scrollTop = $(window).scrollTop();
+
+ if (scrollTop > y_pos - height) {
+ $navbar.addClass("navbar-fixed")
+ } else if (scrollTop <= y_pos) {
+ $navbar.removeClass("navbar-fixed")
+ }
+ });
+
// Display docs subnav items
$('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
});
http://git-wip-us.apache.org/repos/asf/kafka/blob/ca7f3dab/docs/streams/tutorial.html
----------------------------------------------------------------------
diff --git a/docs/streams/tutorial.html b/docs/streams/tutorial.html
index ec41a93..71c9ca3 100644
--- a/docs/streams/tutorial.html
+++ b/docs/streams/tutorial.html
@@ -18,7 +18,17 @@
<script id="content-template" type="text/x-handlebars-template">
<h1>Tutorial: Write a Streams Application</h1>
-
+ <div class="sub-nav-sticky">
+ <div class="sticky-top">
+ <div style="height:35px">
+ <a href="/{{version}}/documentation/streams/">Introduction</a>
+ <a href="/{{version}}/documentation/streams/developer-guide">Developer Guide</a>
+ <a href="/{{version}}/documentation/streams/core-concepts">Concepts</a>
+ <a href="/{{version}}/documentation/streams/quickstart">Run Demo App</a>
+ <a class="active-menu-item" href="/{{version}}/documentation/streams/tutorial">Tutorial: Write App</a>
+ </div>
+ </div>
+ </div>
<p>
In this guide we will start from scratch on setting up your own project to write a stream processing application using Kafka Streams.
It is highly recommended to read the <a href="/{{version}}/documentation/streams/quickstart">quickstart</a> first on how to run a Streams application written in Kafka Streams if you have not done so.
@@ -632,6 +642,21 @@ $(function() {
// Show selected style on nav item
$('.b-nav__streams').addClass('selected');
+ //sticky secondary nav
+ var $navbar = $(".sub-nav-sticky"),
+ y_pos = $navbar.offset().top,
+ height = $navbar.height();
+
+ $(window).scroll(function() {
+ var scrollTop = $(window).scrollTop();
+
+ if (scrollTop > y_pos - height) {
+ $navbar.addClass("navbar-fixed")
+ } else if (scrollTop <= y_pos) {
+ $navbar.removeClass("navbar-fixed")
+ }
+ });
+
// Display docs subnav items
$('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
});