flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aljos...@apache.org
Subject [4/4] git commit: [doc] Backport doc layout changes from 0.7 to 0.6
Date Mon, 22 Sep 2014 11:39:27 GMT
[doc] Backport doc layout changes from 0.7 to 0.6


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

Branch: refs/heads/release-0.6.2
Commit: 0bd2e2d86c50b15dc385b3ef43659ab3a5daeaaa
Parents: 9a7d3d4
Author: Aljoscha Krettek <aljoscha.krettek@gmail.com>
Authored: Mon Sep 22 13:37:42 2014 +0200
Committer: Aljoscha Krettek <aljoscha.krettek@gmail.com>
Committed: Mon Sep 22 13:37:42 2014 +0200

----------------------------------------------------------------------
 .gitignore                          |    2 +
 docs/_config.yml                    |    5 +-
 docs/_includes/footer.md            |   14 +
 docs/_includes/navbar.html          |   26 +
 docs/_includes/sidenav.html         |   56 +
 docs/_layouts/default.html          |   73 +
 docs/_layouts/docs.html             |   97 -
 docs/_plugins/build_apidoc.rb       |   51 +
 docs/css/bootstrap-lumen-custom.css | 6189 ++++++++++++++++++++++++++++++
 docs/css/bootstrap.css              | 5785 ++++++++++++++++++++++++++++
 docs/css/codetabs.css               |   43 +
 docs/css/custom.css                 |    9 +
 docs/hadoop_compatability.md        |    5 -
 docs/hadoop_compatibility.md        |    5 +
 docs/img/apache-incubator-logo.png  |  Bin 0 -> 4234 bytes
 docs/index.md                       |   23 +-
 16 files changed, 12278 insertions(+), 105 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 9c26556..7136797 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,5 @@ tmp
 *.swp
 *.jar
 .DS_Store
+_site
+docs/api

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 31b3083..29b2d66 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -11,6 +11,9 @@ FLINK_VERSION_SHORT: 0.6
 FLINK_ISSUES_URL: https://issues.apache.org/jira/browse/FLINK
 FLINK_GITHUB_URL:  https://github.com/apache/incubator-flink
 
+FLINK_WEBSITE_URL: http://flink.incubator.apache.org
+FLINK_DOWNLOAD_URL: http://flink.incubator.apache.org/downloads.html
+
 FLINK_DOWNLOAD_URL_HADOOP_1_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.6-incubating-bin-hadoop1.tgz
 FLINK_DOWNLOAD_URL_HADOOP_2_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.6-incubating-bin-hadoop2.tgz
 FLINK_DOWNLOAD_URL_YARN_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.6-incubating-bin-hadoop2-yarn.tgz
@@ -27,7 +30,7 @@ defaults:
     scope:
       path: ""
     values:
-      layout: docs
+      layout: default
 
 highlighter: pygments
 markdown: redcarpet

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/docs/_includes/footer.md
----------------------------------------------------------------------
diff --git a/docs/_includes/footer.md b/docs/_includes/footer.md
new file mode 100644
index 0000000..b96adde
--- /dev/null
+++ b/docs/_includes/footer.md
@@ -0,0 +1,14 @@
+<hr class="divider">
+
+<small>Apache Flink is an effort undergoing incubation at The Apache Software
+Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is
+required of all newly accepted projects until a further review indicates that
+the infrastructure, communications, and decision making process have
+stabilized in a manner consistent with other successful ASF projects. While
+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>
+
+<p class="text-center"><a href="{{ site.baseurl }}/privacy-policy.html">Privacy
Policy<a></p>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/docs/_includes/navbar.html
----------------------------------------------------------------------
diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html
new file mode 100644
index 0000000..36c4cf4
--- /dev/null
+++ b/docs/_includes/navbar.html
@@ -0,0 +1,26 @@
+<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
+  <div class="container">
+    <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>
+        <span class="icon-bar"></span>
+        <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>
+      </ul>
+    </div>
+  </div>
+</nav>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/docs/_includes/sidenav.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
new file mode 100644
index 0000000..781edb8
--- /dev/null
+++ b/docs/_includes/sidenav.html
@@ -0,0 +1,56 @@
+<ul>
+    <li>Quickstart
+        <ul>
+            <li><a href="setup_quickstart.html">Install</a></li>
+            <li><a href="run_example_quickstart.html">Run Example</a></li>
+            <li><a href="java_api_quickstart.html">Java API</a></li>
+            <li><a href="scala_api_quickstart.html">Scala API</a></li>
+            <li><a href="faq.html">FAQ</a></li>
+        </ul>
+    </li>
+
+    <li>Setup &amp; Configuration
+        <ul>
+            <li><a href="building.html">Build Instructions</a></li>
+            <li><a href="local_setup.html">Local Setup</a></li>
+            <li><a href="cluster_setup.html">Cluster Setup</a></li>
+            <li><a href="yarn_setup.html">YARN Setup</a></li>
+            <li><a href="config.html">Configuration</a></li>
+        </ul>
+    </li>
+
+    <li>Programming Guides
+        <ul>
+            <li><a href="java_api_guide.html">Java API</a></li>
+            <li><a href="java_api_transformations.html">Java API Transformations</a></li>
+            <li><a href="scala_api_guide.html">Scala API</a></li>
+            <li><a href="iterations.html">Iterations</a></li>
+            <li><a href="spargel_guide.html">Spargel Graph API</a></li>
+        </ul>
+    </li>
+
+    <li>Examples
+        <ul>
+            <li><a href="java_api_examples.html">Java API</a></li>
+            <li><a href="scala_api_examples.html">Scala API</a></li>
+            <li><a href="example_connectors.html">Connecting to other systems</a></li>
+        </ul>
+    </li>
+
+    <li>Execution
+        <ul>
+            <li><a href="local_execution.html">Local/Debugging</a></li>
+            <li><a href="cluster_execution.html">Cluster</a></li>
+            <li><a href="cli.html">Command-Line Interface</a></li>
+            <li><a href="web_client.html">Web Interface</a></li>
+        </ul>
+    </li>
+
+    <li>Internals
+        <ul>
+            <li><a href="internal_overview.html">Overview</a></li>
+            <li><a href="internal_general_arch.html">General Architecture</a></li>
+            <li><a href="internal_add_operator.html">How-to: Adding a new Operator</a></li>
+        </ul>
+    </li>
+</ul>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/docs/_layouts/default.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
new file mode 100644
index 0000000..f33a424
--- /dev/null
+++ b/docs/_layouts/default.html
@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <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">
+    <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/codetabs.js"></script>
+  </head>
+  <body>
+
+    {% include navbar.html %}
+
+    <div style="padding-top:70px" class="container">
+
+      <div class="row">
+        <div class="col-md-3">
+          {% include sidenav.html %}
+        </div>  
+        <div class="col-md-9">
+          <h1>{{ page.title }}</h1>
+
+          {{ content }}
+
+          <div style="padding-top:30px" id="disqus_thread"></div>
+      
+            <script type="text/javascript">
+                /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * *
*/
+                var disqus_shortname = 'stratosphere-eu'; // required: replace example with
your forum shortname
+
+                /* * * DON'T EDIT BELOW THIS LINE * * */
+                (function() {
+                    var dsq = document.createElement('script'); dsq.type = 'text/javascript';
dsq.async = true;
+                    dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+                    (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+                })();
+            </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>
+
+        <div class="footer">
+          {% capture footer %}{% include footer.md %}{% endcapture %}
+          {{ footer | markdownify }}
+        </div>
+      </div>
+    </div>
+
+    
+
+    <script>
+      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+      ga('create', 'UA-52545728-1', 'auto');
+      ga('send', 'pageview');
+
+    </script>
+
+  </body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/docs/_layouts/docs.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/docs.html b/docs/_layouts/docs.html
deleted file mode 100644
index 88d081e..0000000
--- a/docs/_layouts/docs.html
+++ /dev/null
@@ -1,97 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <title>Apache Flink {{ site.FLINK_VERSION_STABLE }} Documentation: {{ page.title
}}</title>
-
-    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
-    <link rel="stylesheet" href="css/syntax.css">
-
-    <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
-    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
-    <!--[if lt IE 9]>
-      <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
-      <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
-    <![endif]-->
-  </head>
-  <body>
-    <div class="container">
-        <div class="row">
-            <h1>Apache Flink {{ site.FLINK_VERSION_STABLE }} Documentation</h1>
-        </div>
-        <div class="row">
-            <div class="col-md-3">
-                <ul>
-                    <li>Quickstart
-                        <ul>
-                            <li><a href="setup_quickstart.html">Install</a></li>
-                            <li><a href="run_example_quickstart.html">Run Example</a></li>
-                            <li><a href="java_api_quickstart.html">Java API</a></li>
-                            <li><a href="scala_api_quickstart.html">Scala API</a></li>
-                            <li><a href="faq.html">FAQ</a></li>
-                        </ul>
-                    </li>
-
-                    <li>Setup &amp; Configuration
-                        <ul>
-                            <li><a href="building.html">Build Instructions</a></li>
-                            <li><a href="local_setup.html">Local Setup</a></li>
-                            <li><a href="cluster_setup.html">Cluster Setup</a></li>
-                            <li><a href="yarn_setup.html">YARN Setup</a></li>
-                            <li><a href="config.html">Configuration</a></li>
-                        </ul>
-                    </li>
-
-                    <li>Programming Guides
-                        <ul>
-                            <li><a href="java_api_guide.html">Java API</a></li>
-                            <li><a href="java_api_transformations.html">Java
API Transformations</a></li>
-                            <li><a href="scala_api_guide.html">Scala API</a></li>
-                            <li><a href="hadoop_compatability.html">Hadoop Compatability</a></li>
-                            <li><a href="iterations.html">Iterations</a></li>
-                            <li><a href="spargel_guide.html">Spargel Graph API</a></li>
-                        </ul>
-                    </li>
-
-                    <li>Examples
-                        <ul>
-                            <li><a href="java_api_examples.html">Java API</a></li>
-                            <li><a href="scala_api_examples.html">Scala API</a></li>
-                            <li><a href="example_connectors.html">Connecting
to other systems</a></li>
-                        </ul>
-                    </li>
-
-                    <li>Execution
-                        <ul>
-                            <li><a href="local_execution.html">Local/Debugging</a></li>
-                            <li><a href="cluster_execution.html">Cluster</a></li>
-                            <li><a href="cli.html">Command-Line Interface</a></li>
-                            <li><a href="web_client.html">Web Interface</a></li>
-                        </ul>
-                    </li>
-
-                    <li>Internals
-                        <ul>
-                            <li><a href="internal_overview.html">Overview</a></li>
-                            <li><a href="internal_general_arch.html">General
Architecture</a></li>
-                            <li><a href="internal_add_operator.html">How-to:
Adding a new Operator</a></li>
-                        </ul>
-                    </li>
-                </ul>
-            </div>
-            <div class="col-md-9">
-                <h1>{{ page.title }}</h1>
-
-                {{ page.content | tocify }}
-
-                {{ content }}
-            </div>
-        </div>
-    </div>
-
-    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
-    <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
-  </body>
-</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/0bd2e2d8/docs/_plugins/build_apidoc.rb
----------------------------------------------------------------------
diff --git a/docs/_plugins/build_apidoc.rb b/docs/_plugins/build_apidoc.rb
new file mode 100644
index 0000000..1b3d925
--- /dev/null
+++ b/docs/_plugins/build_apidoc.rb
@@ -0,0 +1,51 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'fileutils'
+require 'rubygems'
+include FileUtils
+
+if ENV['BUILD_API'] == '1' then
+  # Build Javadoc
+
+  cd("..")
+
+  java8_doc_fix = ""
+
+  java_ver = Gem::Version.new(`java -version 2>&1 | awk -F '"' '/version/ {print $2}'`.gsub('_',
'.'))
+
+  if java_ver > Gem::Version.new("1.8") then
+    puts "Detected Java8, adding -Xdoclint:none"
+    java8_doc_fix = '-DadditionalJOption="-Xdoclint:none"'
+  end
+
+  puts "Running mvn clean install -DskipTests"
+  puts `mvn clean install -DskipTests`
+
+  puts "Generating Javadoc"
+  puts `mvn javadoc:aggregate -Pdocs-and-source $JAVA8JAVADOCFIX -Dmaven.javadoc.failOnError=false
-Dquiet=true -Dheader="<a href=\"/docs/0.6-incubating/\" target=\"_top\"><h1>Back
to Flink Documentation</h1></a>"`
+  
+  cd("docs")
+
+  mkdir_p "api"
+
+  source = "../target/site/apidocs"
+  dest = "api/java/"
+
+  puts "cp -r " + source + "/. " + dest
+  cp_r(source + "/.", dest)
+
+end


Mime
View raw message