theme enhancements for mobile and branding guidelines

rewrite rules added to prevent users from loading up html files meant to be partials add notification over past versions of docs and rename partials make subnav system and add required apache branding links added subnav for docs more branding guideline additions updated apache links removed random closing tag
edoardocomar · Oct 6, 2016 · aa684e5 · aa684e5
1 parent 590fd70
commit aa684e5
Show file tree

Hide file tree

Showing 42 changed files with 562 additions and 383 deletions.
diff --git a/.htaccess b/.htaccess
@@ -1,4 +1,8 @@
 Options +Includes
+RewriteEngine On
 AddType text/html .html
 AddHandler server-parsed .html
-Redirect 301 /design.html /documentation.html#design
+Redirect 301 /design.html /documentation#design
+
+RewriteRule ^/?(\d+)/documentation(\.html)? - [S=1]
+RewriteRule ^/?(\d+)/([a-z]+)(\.html)? /$1/documentation#$2 [R=302,L,NE]
diff --git a/0100/documentation.html b/0100/documentation.html
diff --git a/0100/migration.html b/0100/migration.html
@@ -15,7 +15,7 @@
  limitations under the License.
 -->
 
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 <h2><a id="migration" href="#migration">Migrating from 0.7.x to 0.8</a></h2>
 
 0.8 is our first (and hopefully last) release with a non-backwards-compatible wire protocol, ZooKeeper     layout, and on-disk data format. This was a chance for us to clean up a lot of cruft and start fresh. This means performing a no-downtime upgrade is more painful than normal&mdash;you cannot just swap in the new code in-place.
@@ -31,4 +31,4 @@ <h3><a id="migration_steps" href="#migration_steps">Migration Steps</a></h3>
     <li>Drink.
 </ol>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/0100/protocol.html b/0100/protocol.html
@@ -15,10 +15,10 @@
  limitations under the License.
 -->
 
-<!--#include virtual="../includes/header.html" -->
-<!--#include virtual="../includes/top.html" -->
+<!--#include virtual="../includes/_header.htm" -->
+<!--#include virtual="../includes/_top.htm" -->
 <div class="content">
-	<!--#include virtual="../includes/nav.html" -->
+	<!--#include virtual="../includes/_nav.htm" -->
 	<div class="right">
 		<h1>Kafka protocol guide</h1>
     <p>This document covers the wire protocol implemented in Kafka. It is meant to give a readable guide to the protocol that covers the available requests, their binary format, and the proper way to make use of them to implement a client. This document assumes you understand the basic design and terminology described <a href="https://kafka.apache.org/documentation.html#design">here</a></p>
@@ -222,9 +222,8 @@ <h4><a id="protocol_philosophy" href="#protocol_philosophy">Some Common Philosop
 
     <p>A final question is why we don't use a system like Protocol Buffers or Thrift to define our request messages. These packages excel at helping you to managing lots and lots of serialized messages. However we have only a few messages. Support across languages is somewhat spotty (depending on the package). Finally the mapping between binary log format and wire protocol is something we manage somewhat carefully and this would not be possible with these systems. Finally we prefer the style of versioning APIs explicitly and checking this to inferring new values as nulls as it allows more nuanced control of compatibility.</p>
 
-  <script>
-	// Show selected style on nav item
-	$(function() { $('.b-nav__project').addClass('selected'); });
-	</script>
-
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
+<script>
+// Show selected style on nav item
+$(function() { $('.b-nav__project').addClass('selected'); });
+</script>
diff --git a/0100/quickstart.html b/0100/quickstart.html
@@ -14,7 +14,6 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-
 <p>This tutorial assumes you are starting fresh and have no existing Kafka or ZooKeeper data.</p>
 
 <h4><a id="quickstart_download" href="#quickstart_download">Step 1: Download the code</a></h4>

diff --git a/07/configuration.html b/07/configuration.html
@@ -1,4 +1,4 @@
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 
 <h2> Configuration </h2>
 
@@ -352,4 +352,4 @@ <h3> Important configuration properties for the producer: </h3>
 </table>
 
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/07/documentation.html b/07/documentation.html
@@ -1,8 +1,9 @@
-<!--#include virtual="../includes/header.html" -->
-<!--#include virtual="../includes/top.html" -->
-<div class="content">
-	<!--#include virtual="../includes/nav.html" -->
+<!--#include virtual="../includes/_header.htm" -->
+<!--#include virtual="../includes/_top.htm" -->
+<div class="content documentation">
+	<!--#include virtual="../includes/_nav.htm" -->
 	<div class="right">
+		<!--#include virtual="../includes/_docs_banner.htm" -->
 		<h1>Documentation</h1>
 		<h3>Kafka 0.7</h3>
 
@@ -14,4 +15,5 @@ <h3>Kafka 0.7</h3>
 			<li><a href="http://people.apache.org/~joestein/kafka-0.7.1-incubating-docs">API Docs</a> &ndash; Scaladoc for the api.
 		</ul>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
+<!--#include virtual="../includes/_docs_footer.htm" -->
diff --git a/07/performance.html b/07/performance.html
@@ -1,4 +1,4 @@
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 
 <h2>Performance Results</h2>
 <p>The following tests give some basic information on Kafka throughput as the number of topics, consumers and producers and overall data size varies. Since Kafka nodes are independent, these tests are run with a single producer, consumer, and broker machine. Results can be extrapolated for a larger cluster.
@@ -80,4 +80,4 @@ <h2>How to Run a Performance Test</h2>
 
 <p>The charts similar to above graphs can be plotted with report.html automatically.</p>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/07/quickstart.html b/07/quickstart.html
@@ -1,4 +1,4 @@
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 
 <h2>Quick Start</h2>
 
@@ -306,4 +306,4 @@ <h4>Simple Consumer</h4>
 }
 </pre>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/08/documentation.html b/08/documentation.html
@@ -1,8 +1,9 @@
-<!--#include virtual="../includes/header.html" -->
-<!--#include virtual="../includes/top.html" -->
-<div class="content">
-	<!--#include virtual="../includes/nav.html" -->
+<!--#include virtual="../includes/_header.htm" -->
+<!--#include virtual="../includes/_top.htm" -->
+<div class="content documentation">
+	<!--#include virtual="../includes/_nav.htm" -->
 	<div class="right">
+		<!--#include virtual="../includes/_docs_banner.htm" -->
 		<h1>Documentation</h1>
     <h3>Kafka 0.8.0</h3>
     <i>Documentation for the 0.7 release is <a href="/07/documentation.html">here</a>.</i>
@@ -102,4 +103,5 @@ <h2><a id="tools">7. Tools</a></h2>
 
     <!--#include virtual="tools.html" -->
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
+<!--#include virtual="../includes/_docs_footer.htm" -->
diff --git a/08/migration.html b/08/migration.html
@@ -1,4 +1,4 @@
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 <h2>Migrating from 0.7.x to 0.8</h2>
 
 0.8 is our first (and hopefully last) release with a non-backwards-compatible wire protocol, zookeeper layout, and on-disk data format. This was a chance for us to clean up a lot of cruft and start fresh. This means performing a no-downtime upgrade is more painful than normal&mdash;you cannot just swap in the new code in-place.
@@ -14,4 +14,4 @@ <h3>Migration Steps</h3>
 	<li>Drink.
 </ol>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/081/documentation.html b/081/documentation.html
@@ -1,12 +1,14 @@
-<!--#include virtual="../includes/header.html" -->
-<!--#include virtual="../includes/top.html" -->
-<div class="content">
-	<!--#include virtual="../includes/nav.html" -->
+<!--#include virtual="../includes/_header.htm" -->
+<!--#include virtual="../includes/_top.htm" -->
+<div class="content documentation">
+	<!--#include virtual="../includes/_nav.htm" -->
 	<div class="right">
+		<!--#include virtual="../includes/_docs_banner.htm" -->
 		<h1>Documentation</h1>
     <h3>Kafka 0.8.1</h3>
-    Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documentation.html">0.8.0</a>.
-    </ul>
+		<p>
+    	Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documentation.html">0.8.0</a>.
+    </p>
 
     <ul class="toc">
         <li><a href="#gettingStarted">1. Getting Started</a>
@@ -117,4 +119,5 @@ <h2><a id="operations">6. Operations</a></h2>
 
     <!--#include virtual="ops.html" -->
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
+<!--#include virtual="../includes/_docs_footer.htm" -->
diff --git a/081/migration.html b/081/migration.html
@@ -1,4 +1,4 @@
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 <h2>Migrating from 0.7.x to 0.8</h2>
 
 0.8 is our first (and hopefully last) release with a non-backwards-compatible wire protocol, ZooKeeper     layout, and on-disk data format. This was a chance for us to clean up a lot of cruft and start fresh. This means performing a no-downtime upgrade is more painful than normal&mdash;you cannot just swap in the new code in-place.
@@ -14,4 +14,4 @@ <h3>Migration Steps</h3>
     <li>Drink.
 </ol>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/082/documentation.html b/082/documentation.html
@@ -1,12 +1,14 @@
-<!--#include virtual="../includes/header.html" -->
-<!--#include virtual="../includes/top.html" -->
-<div class="content">
-	<!--#include virtual="../includes/nav.html" -->
+<!--#include virtual="../includes/_header.htm" -->
+<!--#include virtual="../includes/_top.htm" -->
+<div class="content documentation">
+	<!--#include virtual="../includes/_nav.htm" -->
 	<div class="right">
+		<!--#include virtual="../includes/_docs_banner.htm" -->
 		<h1>Documentation</h1>
     <h3>Kafka 0.8.2</h3>
-    Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documentation.html">0.8.0</a>, <a href="/081/documentation.html">0.8.1.X</a>.
-    </ul>
+		<p>
+			Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documentation.html">0.8.0</a>, <a href="/081/documentation.html">0.8.1.X</a>.
+		</p>
 
     <ul class="toc">
         <li><a href="#gettingStarted">1. Getting Started</a>
@@ -117,4 +119,5 @@ <h2><a id="operations">6. Operations</a></h2>
 
     <!--#include virtual="ops.html" -->
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
+<!--#include virtual="../includes/_docs_footer.htm" -->
diff --git a/082/migration.html b/082/migration.html
@@ -1,4 +1,4 @@
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 <h2>Migrating from 0.7.x to 0.8</h2>
 
 0.8 is our first (and hopefully last) release with a non-backwards-compatible wire protocol, ZooKeeper     layout, and on-disk data format. This was a chance for us to clean up a lot of cruft and start fresh. This means performing a no-downtime upgrade is more painful than normal&mdash;you cannot just swap in the new code in-place.
@@ -14,4 +14,4 @@ <h3>Migration Steps</h3>
     <li>Drink.
 </ol>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/090/documentation.html b/090/documentation.html
@@ -15,15 +15,17 @@
  limitations under the License.
 -->
 
-<!--#include virtual="../includes/header.html" -->
-<!--#include virtual="../includes/top.html" -->
-<div class="content">
-	<!--#include virtual="../includes/nav.html" -->
+<!--#include virtual="../includes/_header.htm" -->
+<!--#include virtual="../includes/_top.htm" -->
+<div class="content documentation">
+	<!--#include virtual="../includes/_nav.htm" -->
 	<div class="right">
+		<!--#include virtual="../includes/_docs_banner.htm" -->
 		<h1>Documentation</h1>
     <h3>Kafka 0.9.0</h3>
-    Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documentation.html">0.8.0</a>, <a href="/081/documentation.html">0.8.1.X</a>, <a href="/082/documentation.html">0.8.2.X</a>.
-    </ul>
+		<p>
+    	Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documentation.html">0.8.0</a>, <a href="/081/documentation.html">0.8.1.X</a>, <a href="/082/documentation.html">0.8.2.X</a>.
+		</p>
 
     <ul class="toc">
         <li><a href="#gettingStarted">1. Getting Started</a>
@@ -175,4 +177,5 @@ <h2><a id="security" href="#security">7. Security</a></h2>
     <h2><a id="connect" href="#connect">8. Kafka Connect</a></h2>
     <!--#include virtual="connect.html" -->
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
+<!--#include virtual="../includes/_docs_footer.htm" -->
diff --git a/090/migration.html b/090/migration.html
@@ -15,7 +15,7 @@
  limitations under the License.
 -->
 
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 <h2><a id="migration" href="#migration">Migrating from 0.7.x to 0.8</a></h2>
 
 0.8 is our first (and hopefully last) release with a non-backwards-compatible wire protocol, ZooKeeper     layout, and on-disk data format. This was a chance for us to clean up a lot of cruft and start fresh. This means performing a no-downtime upgrade is more painful than normal&mdash;you cannot just swap in the new code in-place.
@@ -31,4 +31,4 @@ <h3><a id="migration_steps" href="#migration_steps">Migration Steps</a></h3>
     <li>Drink.
 </ol>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/090/protocol.html b/090/protocol.html
@@ -15,7 +15,7 @@
  limitations under the License.
 -->
 
-<!--#include virtual="../includes/header.html" -->
+<!--#include virtual="../includes/_header.htm" -->
 
 <h3><a id="protocol" href="#protocol">Kafka Wire Protocol</a></h3>
 
@@ -179,4 +179,4 @@ <h4><a id="protocol_philosophy" href="#protocol_philosophy">Some Common Philosop
 
 <p>A final question is why we don't use a system like Protocol Buffers or Thrift to define our request messages. These packages excel at helping you to managing lots and lots of serialized messages. However we have only a few messages. Support across languages is somewhat spotty (depending on the package). Finally the mapping between binary log format and wire protocol is something we manage somewhat carefully and this would not be possible with these systems. Finally we prefer the style of versioning APIs explicitly and checking this to inferring new values as nulls as it allows more nuanced control of compatibility.</p>
 
-<!--#include virtual="../includes/footer.html" -->
+<!--#include virtual="../includes/_footer.htm" -->
diff --git a/code.html b/code.html
@@ -1,7 +1,7 @@
-<!--#include virtual="includes/header.html" -->
-<!--#include virtual="includes/top.html" -->
+<!--#include virtual="includes/_header.htm" -->
+<!--#include virtual="includes/_top.htm" -->
 <div class="content">
-	<!--#include virtual="includes/nav.html" -->
+	<!--#include virtual="includes/_nav.htm" -->
 	<div class="right">
 		<h1>Getting the code</h1>
 		<p>
@@ -28,4 +28,4 @@ <h1>Getting the code</h1>
 	$(function() { $('.b-nav__project').addClass('selected'); });
 	</script>
 
-<!--#include virtual="includes/footer.html" -->
+<!--#include virtual="includes/_footer.htm" -->
diff --git a/coding-guide.html b/coding-guide.html
@@ -1,7 +1,7 @@
-<!--#include virtual="includes/header.html" -->
-<!--#include virtual="includes/top.html" -->
+<!--#include virtual="includes/_header.htm" -->
+<!--#include virtual="includes/_top.htm" -->
 <div class="content">
-	<!--#include virtual="includes/nav.html" -->
+	<!--#include virtual="includes/_nav.htm" -->
 	<div class="right">
 		<h1>Coding guidelines</h1>
 		<p>
@@ -107,4 +107,4 @@ <h2>Client Code</h2>
 	$(function() { $('.b-nav__project').addClass('selected'); });
 	</script>
 
-<!--#include virtual="includes/footer.html" -->
+<!--#include virtual="includes/_footer.htm" -->
diff --git a/committers.html b/committers.html
@@ -1,7 +1,7 @@
-<!--#include virtual="includes/header.html" -->
-<!--#include virtual="includes/top.html" -->
+<!--#include virtual="includes/_header.htm" -->
+<!--#include virtual="includes/_top.htm" -->
 <div class="content">
-	<!--#include virtual="includes/nav.html" -->
+	<!--#include virtual="includes/_nav.htm" -->
 	<div class="right">
 		<h1>The committers</h1>
     <table style="margin-top: 4rem;">
@@ -163,4 +163,4 @@ <h1>The committers</h1>
 	$(function() { $('.b-nav__project').addClass('selected'); });
 	</script>
 
-<!--#include virtual="includes/footer.html" -->
+<!--#include virtual="includes/_footer.htm" -->
diff --git a/contact.html b/contact.html
@@ -1,7 +1,7 @@
-<!--#include virtual="includes/header.html" -->
-<!--#include virtual="includes/top.html" -->
+<!--#include virtual="includes/_header.htm" -->
+<!--#include virtual="includes/_top.htm" -->
 <div class="content">
-	<!--#include virtual="includes/nav.html" -->
+	<!--#include virtual="includes/_nav.htm" -->
 	<div class="right">
 		<h1>Contact</h1>
 		<h3>Mailing Lists</h3>
@@ -43,4 +43,4 @@ <h3>IRC</h3>
 // Show selected style on nav item
 $(function() { $('.b-nav__contact').addClass('selected'); });
 </script>
-<!--#include virtual="includes/footer.html" -->
+<!--#include virtual="includes/_footer.htm" -->
diff --git a/contributing.html b/contributing.html
@@ -1,7 +1,7 @@
-<!--#include virtual="includes/header.html" -->
-<!--#include virtual="includes/top.html" -->
+<!--#include virtual="includes/_header.htm" -->
+<!--#include virtual="includes/_top.htm" -->
 <div class="content">
-	<!--#include virtual="includes/nav.html" -->
+	<!--#include virtual="includes/_nav.htm" -->
 	<div class="right">
 		<h1>How to contribute</h1>
 		<p>We are always very happy to have contributions, whether for trivial cleanups or big new features.</p>
@@ -51,4 +51,4 @@ <h2>Becoming a Committer</h2>
 	$(function() { $('.b-nav__project').addClass('selected'); });
 	</script>
 
-<!--#include virtual="includes/footer.html" -->
+<!--#include virtual="includes/_footer.htm" -->