You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by uc...@apache.org on 2014/11/27 11:24:45 UTC

[3/4] incubator-flink git commit: [FLINK-1282] [docs] Update layout of docs

[FLINK-1282] [docs] Update layout of docs

This closes #235.


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

Branch: refs/heads/release-0.7
Commit: 03e50a40a8d5d0867e997c06c7c7ce93128338bc
Parents: cf05958
Author: Kostas Tzoumas <ko...@gmail.com>
Authored: Wed Nov 26 12:23:27 2014 +0100
Committer: Ufuk Celebi <uc...@apache.org>
Committed: Thu Nov 27 11:24:22 2014 +0100

----------------------------------------------------------------------
 docs/_includes/footer.md   |   4 +-
 docs/_includes/navbar.html |  68 +++++---
 docs/_layouts/default.html |  24 +--
 docs/css/custom.css        | 164 +++++++++++++++++-
 docs/css/main/main.css     | 370 ++++++++++++++++++++++++++++++++++++++++
 docs/favicon.ico           | Bin 0 -> 1150 bytes
 docs/favicon.png           | Bin 0 -> 1288 bytes
 docs/img/logo.png          | Bin 0 -> 2457 bytes
 8 files changed, 591 insertions(+), 39 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/_includes/footer.md
----------------------------------------------------------------------
diff --git a/docs/_includes/footer.md b/docs/_includes/footer.md
index b96adde..27e1a54 100644
--- a/docs/_includes/footer.md
+++ b/docs/_includes/footer.md
@@ -9,6 +9,6 @@ incubation status is not necessarily a reflection of the completeness or
 stability of the code, it does indicate that the project has yet to be fully
 endorsed by the ASF.</small>
 
-<a href="http://incubator.apache.org/">![Incubator Logo]({{ site.baseurl }}/img/apache-incubator-logo.png)</a>
+<a href="http://incubator.apache.org/">![Incubator Logo](img/apache-incubator-logo.png)</a>
 
-<p class="text-center"><a href="{{ site.baseurl }}/privacy-policy.html">Privacy Policy<a></p>
\ No newline at end of file
+<p class="text-center"><a href="privacy-policy.html">Privacy Policy<a></p>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/_includes/navbar.html
----------------------------------------------------------------------
diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html
index 29b514d..7666547 100644
--- a/docs/_includes/navbar.html
+++ b/docs/_includes/navbar.html
@@ -1,6 +1,49 @@
 <nav class="navbar navbar-default navbar-fixed-top" role="navigation">
   <div class="container">
-    <div class="navbar-header">
+    <div class="row">
+      <div class="col-md-1 af-mobile-nav-bar">
+	<a href="index.html" title="Home">
+	  <img class="hidden-xs hidden-sm img-responsive"
+	       src="img/logo.png" alt="Apache Flink Logo">
+	</a>	
+	<div class="row visible-xs">
+	  <div class="col-xs-3">
+	    <a href="index.html" title="Home">  
+	      <img class="hidden-x hidden-sm img-responsive"
+		   src="img/logo.png" alt="Apache Flink Logo">
+	    </a>	
+	  </div>
+	  <div class="col-xs-5"></div>
+	  <div class="col-xs-4">
+	    <div class="af-mobile-btn">
+	      <span class="glyphicon glyphicon-plus"></span>
+	    </div>
+	  </div>
+	</div>
+      </div>
+      <!-- Navigation -->
+      <div class="col-md-11">
+	<div class="collapse navbar-collapse" id="navbar-collapse-1">
+	  <ul class="nav navbar-nav">
+
+	    <li>
+	      <a href="index.html" class="{% if page.url contains 'index.html' %}active{% endif %}">Documentation</a>
+	    </li>
+
+	    <li>
+	      <a href="api/java/index.html">Javadoc</a>
+	    </li>
+
+	    <li>
+	      <a href="api/scala/index.html#org.apache.flink.api.scala.package">Scaladoc</a>
+	    </li>
+
+	  </ul>
+	</div>
+      </div>
+    </div>
+  </div>
+<!--    <div class="navbar-header">
       <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
         <span class="sr-only">Toggle navigation</span>
         <span class="icon-bar"></span>
@@ -8,24 +51,5 @@
         <span class="icon-bar"></span>
       </button>
       <a class="navbar-brand" href="http://flink.incubator.apache.org">Apache Flink</a>
-    </div>
-
-    <div class="collapse navbar-collapse" id="navbar-collapse-1">
-      <ul class="nav navbar-nav">
-
-        <li>
-          <a href="index.html" class="{% if page.url contains 'index.html' %}active{% endif %}">Documentation</a>
-        </li>
-
-        <li>
-          <a href="api/java/index.html">Javadoc</a>
-        </li>
-
-        <li>
-          <a href="api/scala/index.html#org.apache.flink.api.scala.package">Scaladoc</a>
-        </li>
-
-      </ul>
-    </div>
-  </div>
-</nav>
\ No newline at end of file
+    </div>-->
+</nav>

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/_layouts/default.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index f33a424..a9896f1 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -5,21 +5,22 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>Apache Flink (incubating): {{ page.title }}</title>
-    <link rel="stylesheet" href="{{ site.baseurl }}/css/bootstrap.css">
-    <link rel="stylesheet" href="{{ site.baseurl }}/css/bootstrap-lumen-custom.css">
-    <link rel="stylesheet" href="{{ site.baseurl }}/css/syntax.css">
-    <link rel="/css/custom.css">
-    <link rel="css/codetabs.css">
-    <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">
+    <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
+    <link rel="icon" href="favicon.ico" type="image/x-icon">
+    <link rel="stylesheet" href="css/bootstrap.css">
+    <link rel="stylesheet" href="css/bootstrap-lumen-custom.css">
+    <link rel="stylesheet" href="css/syntax.css">
+    <link rel="stylesheet" href="css/custom.css">
+    <link href="css/main/main.css" rel="stylesheet">
     <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
-    <script src="/js/bootstrap.min.js"></script>
+    <script src="js/bootstrap.min.js"></script>
     <script src="js/codetabs.js"></script>
   </head>
   <body>
 
     {% include navbar.html %}
 
-    <div style="padding-top:70px" class="container">
+    <div style="padding-top:120px" class="container">
 
       <div class="row">
         <div class="col-md-3">
@@ -27,9 +28,10 @@
         </div>  
         <div class="col-md-9">
           <h1>{{ page.title }}</h1>
-
+	  
           {{ content }}
-
+	  
+        <!-- Disqus Area -->
           <div style="padding-top:30px" id="disqus_thread"></div>
       
             <script type="text/javascript">
@@ -44,8 +46,6 @@
                 })();
             </script>
             <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
-            <a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
-
           </div>
         </div>
 

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/css/custom.css
----------------------------------------------------------------------
diff --git a/docs/css/custom.css b/docs/css/custom.css
index 3662ec1..43b6565 100644
--- a/docs/css/custom.css
+++ b/docs/css/custom.css
@@ -1,9 +1,167 @@
 .extLink {
-	display:inline !important; 
-	padding-right:3px !important;
+	display: inline !important; 
+	padding-right: 3px !important;
 }
 
 .small-font-awesome {
-	font-size:10px;
+	font-size: 10px;
 	padding-right: 10px;
+}
+
+#logo-element {
+    display: inline-block;
+    float: left;
+    width: 40px;
+    margin-top: 5px;
+    margin-right: 5px;
+}
+
+/*** Web Trust CSS ***/
+#af-upfooter {
+	margin-top: 50px;
+}
+
+/* Navigation Bar */
+.navbar {
+    padding-top: 20px;
+    padding-bottom: 20px;
+}
+
+.navbar {
+	border:none !important;
+}
+
+.navbar-default {
+    background: #08131F !important;
+}
+
+.navbar-default .navbar-nav > li > a {
+    color: #fff !important;
+    font-weight: normal;
+}
+
+.navbar-brand img {
+	margin-top: -15px;
+}
+
+@media (min-width: 768px) {
+	.navbar-nav {
+		margin-left: 5%;
+	}
+}
+
+/* Side Bar */
+.af-sidebar ul {
+	list-style-type: none;
+}
+
+.af-sidebar-item.active a {
+	color: #555;
+	text-decoration: underline;
+}
+
+.af-label {
+	background: #08131F;
+	border-radius: 5px;
+	color: #fff;
+	display: block;
+	font-size: 0.95em;
+    margin: 10px 0;
+    padding: 0.4em 0.8em;
+}
+
+.af-sidebar ul ul {
+	background: #fff;
+	list-style-type: disc;
+}
+
+/* Downloads Page */
+.af-download-row {
+    margin-top: 40px;
+    margin-bottom: 40px;	
+}
+
+.af-download-row h3 {
+	font-size: 1.8em;
+	margin: 0 0 15px 0;
+	padding: 0;
+}
+
+.af-download-row h3 span {
+	font-size: 0.7em;
+}
+
+.af-blue-color {
+	color: #3795c6;
+}
+
+.af-download-usage {
+	min-height: 115px;
+}
+
+.af-download-usage p {
+	color: #959595;
+	font-size: 0.9em;
+}
+
+.af-download-button {
+	background: #3795c6;
+	color: #fff !important;
+	font-size: 0.9em;
+	font-weight: bold;
+	display: block;
+	margin: 8px auto;
+	text-align:center;
+	width: 200px;
+}
+
+.af-download-button:hover {
+	background: #006599 !important;
+}
+
+.af-small-download-heading {
+	text-align: center;
+}
+
+.af-small-download-area {
+    margin-top: 40px;
+    margin-bottom: 40px;
+}
+
+/* Community Page */
+
+.af-team-member-inner {
+    padding-top: 20px;	
+}
+
+.af-team-member-img {
+	margin:10px auto;
+	width: 70%;
+}
+
+.af-team-member-img img {
+	border-radius: 100%;
+	margin: auto;
+}
+
+.af-team-member-info {
+	font-size: 0.9em;
+	margin: 15px 0;
+	text-align: center;
+}
+
+.af-mailinglist-item {
+	margin: 40px auto; 
+	text-align: center;
+}
+
+.af-mailinglist-item-inner {
+	background: #ececec;
+	border-radius: 6px;
+	padding: 10px 2% 40px 2%;
+}
+
+.af-mailinglist-item-inner p {
+	font-weight: bold;
+	margin: 20px 0;
 }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/css/main/main.css
----------------------------------------------------------------------
diff --git a/docs/css/main/main.css b/docs/css/main/main.css
new file mode 100755
index 0000000..2aec75d
--- /dev/null
+++ b/docs/css/main/main.css
@@ -0,0 +1,370 @@
+/*----------------------------------------------------------------------
+    General
+----------------------------------------------------------------------*/
+
+/* Override Bootstrap Style */
+body {
+    font-family: Helvetica, Arial, sans-serif;
+}
+
+html {
+	font-size: 100%;
+}
+
+body {
+	font-size: 100%;
+}
+
+ul {
+	list-style-type: none;
+}
+
+.af-privacy-policy {
+	display: inline-block; 
+	font-style: normal;
+	font-size: 0.9em;
+	margin: 30px auto 0 auto;
+	font-style: normal;
+}
+
+.af-separator {
+	color: #ccc;
+}
+
+.divider {
+    border-bottom: 1px solid #ccc;
+	height: 4px;
+	margin: 8px 0 12px 0 !important;
+	overflow: hidden;
+	padding: 0;
+}
+
+/* Headings */
+.af-heading3 {
+	font-weight: bold;
+	margin-bottom: 20px;
+}
+
+/* Buttons */
+.af-btn {
+	color: #fff;
+	display: block;
+	padding: 0.4em 0.9em;
+	text-align: center;
+	text-decoration: none !important;
+}
+
+.af-btn:hover {
+	color: #fff;
+}
+
+.af-btn-large {
+	font-size: 1.4em;
+}
+
+.af-btn-orange {
+	background: #FA5F00;
+	border: 1px solid #7c5a2f;
+}
+
+.af-btn-blue {
+	background: #3795c6;
+	border: 1px solid #2c6e92;
+}
+
+/* Sections */
+.af-section {
+	font-size: 1.2em; 
+	padding-top : 35px;
+	padding-bottom: 35px;
+	padding-top: 35px;
+}
+
+.af-colored {
+	background: #2c3e50;
+	color: #fff;
+}
+
+/* General */
+
+.af-inner-pages-navigation {
+	padding-bottom:20px;
+}
+
+/*----------------------------------------------------------------------
+    Layout
+----------------------------------------------------------------------*/
+
+/* Header */
+.af-header-container {
+	background: #08131F;
+	/* #2c3e50 / #08131F my proposal*/
+	padding-top: 20px;
+}
+
+/* Navigation */
+.af-main-nav ul {
+	float: right;
+	margin-top: 20px;
+}
+
+.af-main-nav li {
+	float: left;
+	margin-right: 55px;
+	position: relative;
+}
+
+.af-main-nav li a {
+	color: #fff;
+	font-size: 1.15em;
+}
+
+.af-main-nav ul.af-dropdown-menu {
+	display:none;
+} 
+
+.caret {
+    display: inline-block;
+	width: 0;
+	height: 0;
+	margin-left: 2px;
+	vertical-align: middle;
+	border-top: 4px solid;
+	border-right: 4px solid rgba(0, 0, 0, 0);
+	border-left: 4px solid rgba(0, 0, 0, 0);
+}
+
+/* Front Top Area */
+.af-front-top {
+	text-align: center;
+	margin: 30px auto;
+}
+
+.af-front-top-logo {
+	margin: 30px auto 50px auto;
+	width: 30%;
+}
+
+.af-front-top-headline1 {
+	color: #fff;
+	font-size: 3.6em;
+}
+
+.af-front-top-headline2 {
+	color: #fff;
+	font-size: 1.8em;
+	font-weight: normal;
+	margin-top: 30px;
+}
+
+/* Front Top Buttons */
+.af-front-top-buttons {
+	background: #1b2e3d;
+	padding-top: 18px;
+	padding-bottom: 18px;
+}
+
+/* Front Page Icons */
+#af-assets {
+	padding-top: 65px;
+	padding-bottom: 65px;
+}
+
+.af-asset {
+	text-align: center;
+}
+
+.af-asset-img {
+	background: #08131F;
+	border-radius: 100%;
+	height: 100px;
+	margin: 0px auto 15px auto;
+	width: 100px;
+}
+
+.af-asset-img:hover {
+	background: #3795c6;
+}
+
+.af-asset-img img {
+	padding: 30px;
+}
+
+.af-asset-heading {
+	color: #2c3e50;
+	font-weight: bold;
+}
+
+.af-section-row {
+	margin-top: 25px;
+}
+
+/* Up Footer */
+#af-upfooter {
+	background: #e6e6e6;
+	font-style: italic;
+}
+
+#af-upfooter img {
+	margin: 20px auto 0 auto;
+}
+
+/* Footer */
+#af-footer {
+	background: #101416;
+	color: #fff;
+	padding: 20px 0 0 0;
+}
+
+#af-footer h3 {
+	font-size: 1.2em;
+	color: #fff !important;
+}
+
+.af-footer-menu {
+	margin: 35px 0 35px 0;
+	padding: 0;
+}
+
+.af-footer-menu li {
+	padding: 0 0 15px 0;
+}
+
+.af-footer-menu li a {
+	color: #fff;
+}
+
+.af-footer-bar {
+	background: #0d100e;
+	color: #fff;
+	font-size: 0.9em;
+	padding: 17px 0;
+}
+
+.af-footer-bar a {
+	color: #F7931E;
+}
+
+.af-footer-img {
+	display: inline-block;
+	margin-right: 2%;
+	width: 30px;
+}
+
+.af-footer-menu span {
+	font-size: 0.8em;
+}
+
+/*----------------------------------------------------------------------
+    Responsive CSS 768px / 992px / 1200px
+----------------------------------------------------------------------*/
+
+@media all and (min-width: 768px) {
+    
+    /* Navigation */
+    .af-main-nav > ul {
+       display:block !important;
+    }
+    
+   .af-main-nav ul.af-dropdown-menu {
+        background: #1B2E3D;
+        border-bottom-left-radius: 5px;
+        border-bottom-right-radius: 5px;
+        display: none;
+        margin: 5px 0 0 0;
+        padding: 10px 0;
+        position: absolute;
+        z-index: 10;
+    }
+    
+    .af-dropdown-menu li {
+        display: block;
+        float: none;
+        margin: 0;
+        padding: 3px 20px;
+    }
+    
+    .af-dropdown-menu li a {
+        font-size: 1em;
+        white-space: nowrap;
+    }
+}
+
+/* Medium Devices */
+@media all and (max-width: 1190px) {
+
+	/* Navigation */
+	.af-main-nav li {
+		margin-right: 25px;
+	}
+	
+	.af-main-nav li a {
+		color: #fff;
+		font-size: 1em;
+	}
+}
+
+/* Small Devices */
+@media all and (max-width: 991px) {
+    
+    /* Navigation */
+    .af-main-nav ul {
+        float: none;
+    }
+    
+	/* Sections */
+	.af-section-img {
+		margin: 35px auto;
+	}
+
+}
+
+/* XSmall Devices */
+@media all and (max-width: 767px) {
+	
+	.af-header-container {
+	   padding-top: 0;
+	}
+	
+	.af-mobile-nav-bar {
+	   color: #fff;
+	   padding-top: 20px;
+	   padding-bottom: 20px;
+	}
+	
+	.af-mobile-nav-bar .glyphicon {
+	   font-size: 1.5em;
+	} 
+	
+	.af-mobile-btn {
+	   background: #FA5F00;
+	   margin-right: -15px;
+	   padding: 10px;
+	}
+	
+	/* Navigation */
+	.af-main-nav ul {
+	   margin: 0;
+	   padding: 0;
+	   display:none;
+	}
+	
+	.af-main-nav ul li {
+		float: none;
+		border-bottom:1px solid #fff;
+		padding: 0;
+		margin: 0;
+	}
+	
+	.af-main-nav ul li a {
+	   background: #1B2E3D;
+	   display: block;
+	   font-size: 0.9em;
+	   font-weight:bold;
+	   padding: 15px 10px;
+	}
+	
+	.af-main-nav ul li.active a {
+       background: #FA5F00;
+    }
+}
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/favicon.ico
----------------------------------------------------------------------
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100755
index 0000000..41f40ed
Binary files /dev/null and b/docs/favicon.ico differ

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/favicon.png
----------------------------------------------------------------------
diff --git a/docs/favicon.png b/docs/favicon.png
new file mode 100755
index 0000000..54bbfd5
Binary files /dev/null and b/docs/favicon.png differ

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/03e50a40/docs/img/logo.png
----------------------------------------------------------------------
diff --git a/docs/img/logo.png b/docs/img/logo.png
new file mode 100755
index 0000000..8a7996d
Binary files /dev/null and b/docs/img/logo.png differ