Skip to content

F
flink

doujutun3207 / flink
与 Fork 源项目一致

从无法访问的项目Fork

通知 24
Star 0
Fork 0
F
flink

体验新版 GitCode，发现更多精彩内容 >>

提交 b8a8780f 编写于 作者: A Aljoscha Krettek
浏览文件
操作

Turn Documentation into standalone website, add Overview Page 

This can now be built standalone and then copied into the correct docs
folder of the website SVN.

The index page now has a short overview and a table of contents.
上级 15060ef4
展开全部 隐藏空白更改
内联 并排
Showing with 12726 addition and 221 deletion
.gitignore
浏览文件 @ b8a8780f
...@@ -15,3 +15,5 @@ tmp ...@@ -15,3 +15,5 @@ tmp
*.swp *.swp
*.jar *.jar
.DS_Store .DS_Store
_site
docs/api
docs/_config.yml
浏览文件 @ b8a8780f
...@@ -6,11 +6,16 @@ ...@@ -6,11 +6,16 @@
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
FLINK_VERSION_STABLE: 0.7-incubating # this variable can point to a SNAPSHOT version in the git source. FLINK_VERSION_STABLE: 0.7-incubating # this variable can point to a SNAPSHOT version in the git source.
FLINK_VERSION_HADOOP_2_STABLE: 0.7-hadoop2-incubating
FLINK_VERSION_SHORT: 0.7 FLINK_VERSION_SHORT: 0.7
FLINK_VERSION_HADOOP_2_STABLE: 0.7-hadoop2-incubating
FLINK_SCALA_VERSION: 2.10.4
FLINK_SCALA_VERSION_SHORT: 2.10
FLINK_ISSUES_URL: https://issues.apache.org/jira/browse/FLINK FLINK_ISSUES_URL: https://issues.apache.org/jira/browse/FLINK
FLINK_GITHUB_URL: https://github.com/apache/incubator-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.7-incubating-bin-hadoop1.tgz FLINK_DOWNLOAD_URL_HADOOP_1_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7-incubating-bin-hadoop1.tgz
FLINK_DOWNLOAD_URL_HADOOP_2_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7-incubating-bin-hadoop2.tgz FLINK_DOWNLOAD_URL_HADOOP_2_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7-incubating-bin-hadoop2.tgz
FLINK_DOWNLOAD_URL_YARN_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7-incubating-bin-hadoop2-yarn.tgz FLINK_DOWNLOAD_URL_YARN_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7-incubating-bin-hadoop2-yarn.tgz
...@@ -27,7 +32,7 @@ defaults: ...@@ -27,7 +32,7 @@ defaults:
scope: scope:
path: "" path: ""
values: values:
layout: docs layout: default
highlighter: pygments highlighter: pygments
markdown: KramdownPygments markdown: KramdownPygments
......
docs/_includes/footer.md 0 → 100644
浏览文件 @ b8a8780f
<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
docs/_includes/navbar.html 0 → 100644
浏览文件 @ b8a8780f
<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
docs/_includes/sidenav.html 0 → 100644
浏览文件 @ b8a8780f
<ul>
<li><a href="faq.html">FAQ</a></li>
<li>Quickstart
<ul>
<li><a href="setup_quickstart.html">Setup</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>
</ul>
</li>
<li>Setup &amp; Configuration
<ul>
<li><a href="local_setup.html">Local Setup</a></li>
<li><a href="building.html">Build Flink</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="programming_guide.html">Programming Guide</a></li>
<li><a href="dataset_transformations.html">DataSet Transformations</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="examples.html">Bundled Examples</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>
</ul>
</li>
</ul>
docs/_layouts/default.html 0 → 100644
浏览文件 @ b8a8780f
<!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>
docs/_layouts/docs.html 已删除 100644 → 0
浏览文件 @ 15060ef4
<!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">
<link rel="stylesheet" href="css/codetabs.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="programming_guide.html">Flink Programming Guide</a></li>
<li><a href="dataset_transformations.html">DataSet Transformations</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="examples.html">Bundled Examples</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>
<li><a href="internal_logging.html">How-to: Logging</a></li>
</ul>
</li>
</ul>
</div>
<div class="col-md-9">
<h1>{{ page.title }}</h1>
{{ 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>
<script src="js/codetabs.js"></script>
</body>
</html>
\ No newline at end of file
docs/_plugins/build_apidoc.rb 0 → 100644
浏览文件 @ b8a8780f
# 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 and Scaladoc
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=\"/\" 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
docs/css/bootstrap-lumen-custom.css 0 → 100644
浏览文件 @ b8a8780f
此差异已折叠。
docs/css/bootstrap.css 0 → 100644
浏览文件 @ b8a8780f
此差异已折叠。
docs/css/custom.css 0 → 100644
浏览文件 @ b8a8780f
.extLink {
display:inline !important;
padding-right:3px !important;
}
.small-font-awesome {
font-size:10px;
padding-right: 10px;
}
\ No newline at end of file
docs/dataset_transformations.md
浏览文件 @ b8a8780f
此差异已折叠。
docs/index.md
浏览文件 @ b8a8780f
--- ---
layout: docs title: Flink Overview
title: Apache Flink Documentation
--- ---
Apache Flink (incubating) is a platform for efficient, distributed, general-purpose data processing.
It features powerful programming abstractions in Java and Scala, a high-performance runtime, and
automatic program optimization. It has native support for iterations, incremental iterations, and
programs consisting of large DAGs of operations.
If you quickly want to try out the system, please look at one of the available quickstarts. For
a thorough introduction of the Flink API please refer to the
[Programming Guide](programming_guide.htmls).
## Download
You can download Flink from the [downloads]({{ site.FLINK_DOWNLOAD_URL }}) page
of the [project website]({{ site.FLINK_WEBSITE_URL }}). This documentation if for version {{ site.FLINK_VERSION_STABLE }}. Be careful
when picking a version, there are different versions depending on the Hadoop and/or
HDFS version that you want to use with Flink. Please refer to [building](building.html) if you
want to build Flink yourself from the source.
In Version {{ site.FLINK_VERSION}} the Scala API uses {{ site.SCALA_VERSION_SHORT}}. Please make
sure to use a compatible version.
docs/js/bootstrap.min.js 0 → 100644
浏览文件 @ b8a8780f
此差异已折叠。
docs/programming_guide.md
浏览文件 @ b8a8780f
...@@ -1235,7 +1235,7 @@ wordCounts groupBy { _.word } reduce(new MyReduceFunction()) ...@@ -1235,7 +1235,7 @@ wordCounts groupBy { _.word } reduce(new MyReduceFunction())
<div class="codetabs" markdown="1"> <div class="codetabs" markdown="1">
<div data-lang="java" markdown="1"> <div data-lang="java" markdown="1">
You can use the `Tuple` classes for composite types. Tuples contain a fix number of fields of You can use the Tuple classes for composite types. Tuples contain a fix number of fields of
various types. The Java API provides classes from `Tuple1` up to `Tuple25`. Every field of a tuple various types. The Java API provides classes from `Tuple1` up to `Tuple25`. Every field of a tuple
can be an arbitrary Flink type - including further tuples, resulting in nested tuples. Fields of a can be an arbitrary Flink type - including further tuples, resulting in nested tuples. Fields of a
Tuple can be accessed directly using the fields `tuple.f4`, or using the generic getter method Tuple can be accessed directly using the fields `tuple.f4`, or using the generic getter method
...@@ -1266,7 +1266,7 @@ wordCounts ...@@ -1266,7 +1266,7 @@ wordCounts
{% endhighlight %} {% endhighlight %}
In order to access fields more intuitively and to generate more readable code, it is also possible In order to access fields more intuitively and to generate more readable code, it is also possible
to extend a subclass of `Tuple`. You can add getters and setters with custom names that delegate to to extend a subclass of Tuple. You can add getters and setters with custom names that delegate to
the field positions. See this the field positions. See this
{% gh_link /flink-examples/flink-java-examples/src/main/java/org/apache/flink/example/java/relational/TPCHQuery3.java "example" %} for an {% gh_link /flink-examples/flink-java-examples/src/main/java/org/apache/flink/example/java/relational/TPCHQuery3.java "example" %} for an
illustration how to make use of that mechanism. illustration how to make use of that mechanism.
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或