commit | 644c27504ad6fb89372e3b39123a4f896013e1ad | [log] [tgz] |
---|---|---|
author | Maximilian Michels <mxm@apache.org> | Mon May 16 15:02:59 2016 +0200 |
committer | Maximilian Michels <mxm@apache.org> | Tue May 31 12:27:23 2016 +0200 |
tree | c53b7bf4ade4508f44195043aecd0172a5109c76 | |
parent | 9f80376a32990458ccd4ab9540fd4bcae12f0f7d [diff] |
[FLINK-3887] improve dependency management for building docs The Flink documentation build process is currently quite messy. These changes move us to a new build process with proper dependency handling. It assures that we all use the same dependency versions for consistent build output. Also, it eases the automated building process on other systems (like the ASF Buildbot). The goal was to make the documentation build process easier and self-contained. - use Ruby's Bundler Gem to install dependencies - update README - adapt Dockerfile - add additional rules to .gitignore - change default doc output path from /target to /content (default path of the flink-web repository) This closes #2033
Apache Flink is an open source platform for scalable batch and stream data processing. Flink supports batch and streaming analytics, in one system. Analytical programs can be written in concise and elegant APIs in Java and Scala.
case class WordWithCount(word: String, count: Int) val text = env.readTextFile(path) val counts = text.flatMap { _.split("\\W+") } .map { WordWithCount(_, 1) } .groupBy("word") .sum("count") counts.writeAsCsv(outputPath)
These are some of the unique features of Flink:
Learn more about Flink at http://flink.apache.org/
Prerequisites for building Flink:
git clone https://github.com/apache/flink.git cd flink mvn clean package -DskipTests # this will take up to 5 minutes
Flink is now installed in build-target
The Flink committers use IntelliJ IDEA and Eclipse IDE to develop the Flink codebase.
Minimal requirements for an IDE are:
The IntelliJ IDE supports Maven out of the box and offers a plugin for Scala development.
Check out our Setting up IntelliJ guide for details.
For Eclipse users, we recommend using Scala IDE 3.0.3, based on Eclipse Kepler. While this is a slightly older version, we found it to be the version that works most robustly for a complex project like Flink.
Further details, and a guide to newer Scala IDE versions can be found in the How to setup Eclipse docs.
Note: Before following this setup, make sure to run the build from the command line once (mvn clean install -DskipTests
, see above)
Don’t hesitate to ask!
Contact the developers and community on the mailing lists if you need any help.
Open an issue if you found a bug in Flink.
The documentation of Apache Flink is located on the website: http://flink.apache.org or in the docs/
directory of the source code.
This is an active open-source project. We are always open to people who want to use the system or contribute to it. Contact us if you are looking for implementation tasks that fit your skills. This article describes how to contribute to Apache Flink.
Apache Flink is an open source project of The Apache Software Foundation (ASF). The Apache Flink project originated from the Stratosphere research project.