Return-Path: X-Original-To: apmail-flink-commits-archive@minotaur.apache.org Delivered-To: apmail-flink-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A9443116AA for ; Mon, 22 Sep 2014 11:39:52 +0000 (UTC) Received: (qmail 24360 invoked by uid 500); 22 Sep 2014 11:39:52 -0000 Delivered-To: apmail-flink-commits-archive@flink.apache.org Received: (qmail 24333 invoked by uid 500); 22 Sep 2014 11:39:52 -0000 Mailing-List: contact commits-help@flink.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@flink.incubator.apache.org Delivered-To: mailing list commits@flink.incubator.apache.org Received: (qmail 24318 invoked by uid 99); 22 Sep 2014 11:39:52 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 22 Sep 2014 11:39:52 +0000 X-ASF-Spam-Status: No, hits=-2000.8 required=5.0 tests=ALL_TRUSTED,RP_MATCHES_RCVD X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO mail.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with SMTP; Mon, 22 Sep 2014 11:39:28 +0000 Received: (qmail 23878 invoked by uid 99); 22 Sep 2014 11:39:25 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 22 Sep 2014 11:39:25 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id F2AB59488B5; Mon, 22 Sep 2014 11:39:24 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: aljoscha@apache.org To: commits@flink.incubator.apache.org Date: Mon, 22 Sep 2014 11:39:27 -0000 Message-Id: <6e6a5d2fc48046b3abcb6c934cda8eec@git.apache.org> In-Reply-To: <3b03d377c39f47b1bd7b495d79de1624@git.apache.org> References: <3b03d377c39f47b1bd7b495d79de1624@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [4/4] git commit: [doc] Backport doc layout changes from 0.7 to 0.6 X-Virus-Checked: Checked by ClamAV on apache.org [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 Authored: Mon Sep 22 13:37:42 2014 +0200 Committer: Aljoscha Krettek 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 @@ +
+ +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. + +![Incubator Logo]({{ site.baseurl }}/img/apache-incubator-logo.png) + +

Privacy Policy

\ 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 @@ + \ 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 @@ + \ 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 @@ + + + + + + + Apache Flink (incubating): {{ page.title }} + + + + + + + + + + + + + {% include navbar.html %} + +
+ +
+
+ {% include sidenav.html %} +
+
+

{{ page.title }}

+ + {{ content }} + +
+ + + + comments powered by Disqus + +
+
+ +
+ {% capture footer %}{% include footer.md %}{% endcapture %} + {{ footer | markdownify }} +
+
+ + + + + + + + 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 @@ - - - - - - - Apache Flink {{ site.FLINK_VERSION_STABLE }} Documentation: {{ page.title }} - - - - - - - - - -
-
-

Apache Flink {{ site.FLINK_VERSION_STABLE }} Documentation

-
-
-
- -
-
-

{{ page.title }}

- - {{ page.content | tocify }} - - {{ content }} -
-
-
- - - - - \ 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="

Back to Flink Documentation

"` + + cd("docs") + + mkdir_p "api" + + source = "../target/site/apidocs" + dest = "api/java/" + + puts "cp -r " + source + "/. " + dest + cp_r(source + "/.", dest) + +end