diff --git a/docs/internal_howto.md b/docs/internal_howto.md index 1aa1c9b2cc728d3a6d8e7095b21bb46941fe029d..5cdb2212f4832bb61a7fa4c48db4569f277f43f6 100644 --- a/docs/internal_howto.md +++ b/docs/internal_howto.md @@ -33,6 +33,8 @@ that are interested in the technology behind Flink. - [How-to: Setting up Eclipse to develop Flink](internal_setup_eclipse.html) +- [How-to: Setting up IntelliJ to develop Flink](internal_setup_intellij.html) + --- *This documentation is maintained by the contributors of the individual components. diff --git a/docs/internal_setup_intellij.md b/docs/internal_setup_intellij.md new file mode 100644 index 0000000000000000000000000000000000000000..ff6758b85d73f79d0ea3771af4306d5e0771ba15 --- /dev/null +++ b/docs/internal_setup_intellij.md @@ -0,0 +1,56 @@ +--- +title: "How to set up IntelliJ IDEA" +--- + + + + +A brief guide on how to set up IntelliJ IDEA IDE for development of the Flink core. +As Eclipse is known to have issues with mixed Scala and Java projects, more and more contributers are migrating to IntelliJ IDEA. + +The following documentation describes the steps to setup IntelliJ IDEA 14.0.3 (https://www.jetbrains.com/idea/download/) with the Flink sources. + +Prior to doing anything, make sure that the Flink project is built at least once from the terminal: +`mvn clean package -DskipTests` + +# IntelliJ IDEA + +## Installing the Scala plugin +1. Go to IntelliJ plugins settings (File -> Settings -> Plugins) and click on "Install Jetbrains plugin...". +2. Select and install the "Scala" plugin. +3. Restart IntelliJ + +## Installing the Scala compiler plugin +1. Go to IntelliJ scala compiler settings (File -> Settings -> Build, Execution, Deployment -> Compiler -> Scala Compiler) and click on "Install Jetbrains plugin...". +2. Click on the green plus icon on the right to add a compiler plugin +3. Point to the paradise jar: ~/.m2/repository/org/scalamacros/paradise_2.10.4/2.0.1/paradise_2.10.4-2.0.1.jar If there is no such file, this means that you should build Flink from the terminal as explained above. + +## Importing Flink +1. Start IntelliJ IDEA and choose "Import Project" +2. Select the root folder of the Flink repository +3. Choose "Import project from external model" and select "Maven" +4. Leave the default options and finish the import. + +--- + +*This documentation is maintained by the contributors of the individual components. +We kindly ask anyone that adds and changes components to eventually provide a patch +or pull request that updates these documents as well.* +