You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2019/07/03 22:34:57 UTC
[flink] 02/07: [hotfix] [docs] Update IDE setup instructions for
latest IntelliJ IDEA
This is an automated email from the ASF dual-hosted git repository.
sewen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit b5f4f327f6537f1ec796d35c7ee1f2a65dab3565
Author: Hugo Da Cruz Louro <hm...@apache.org>
AuthorDate: Wed Jun 26 23:46:31 2019 -0700
[hotfix] [docs] Update IDE setup instructions for latest IntelliJ IDEA
This closes #8908
---
docs/flinkDev/ide_setup.md | 23 ++++++++++++-----------
docs/flinkDev/ide_setup.zh.md | 23 ++++++++++++-----------
2 files changed, 24 insertions(+), 22 deletions(-)
diff --git a/docs/flinkDev/ide_setup.md b/docs/flinkDev/ide_setup.md
index c6b0cd2..c27e479 100644
--- a/docs/flinkDev/ide_setup.md
+++ b/docs/flinkDev/ide_setup.md
@@ -49,7 +49,7 @@ git clone https://github.com/apache/flink.git
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 contributors are migrating to IntelliJ IDEA.
-The following documentation describes the steps to setup IntelliJ IDEA 2016.2.5
+The following documentation describes the steps to setup IntelliJ IDEA 2019.1.3
([https://www.jetbrains.com/idea/download/](https://www.jetbrains.com/idea/download/))
with the Flink sources.
@@ -66,19 +66,20 @@ to enable support for Scala projects and files:
### Importing Flink
-1. Start IntelliJ IDEA and choose "Import Project"
-2. Select the root folder of the Flink repository
+1. Start IntelliJ IDEA and choose "New -> Project from Existing Sources"
+2. Select the root folder of the cloned Flink repository
3. Choose "Import project from external model" and select "Maven"
-4. Leave the default options and click on "Next" until you hit the SDK section.
-5. If there is no SDK, create a one with the "+" sign top left,
- then click "JDK", select your JDK home directory and click "OK".
- Otherwise simply select your SDK.
-6. Continue by clicking "Next" again and finish the import.
+4. Leave the default options and successively click "Next" until you reach the SDK section.
+5. If there is no SDK listed, create one using the "+" sign on the top left.
+ Select "JDK", choose the JDK home directory and click "OK".
+ Select the most suiting JDK version. NOTE: A good rule of thumb is to select
+ the JDK version matching the active Maven profile.
+6. Continue by clicking "Next" until finishing the import.
7. Right-click on the imported Flink project -> Maven -> Generate Sources and Update Folders.
Note that this will install Flink libraries in your local Maven repository,
- i.e. "/home/*-your-user-*/.m2/repository/org/apache/flink/".
- Alternatively, `mvn clean package -DskipTests` also creates the necessary
- files for the IDE to work with but without installing libraries.
+ located by default at "/home/$USER/.m2/repository/org/apache/flink/".
+ Alternatively, `mvn clean package -DskipTests` also creates the files necessary
+ for the IDE to work but without installing the libraries.
8. Build the Project (Build -> Make Project)
### Checkstyle For Java
diff --git a/docs/flinkDev/ide_setup.zh.md b/docs/flinkDev/ide_setup.zh.md
index a893d66..1177c6a 100644
--- a/docs/flinkDev/ide_setup.zh.md
+++ b/docs/flinkDev/ide_setup.zh.md
@@ -49,7 +49,7 @@ git clone https://github.com/apache/flink.git
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 contributors are migrating to IntelliJ IDEA.
-The following documentation describes the steps to setup IntelliJ IDEA 2016.2.5
+The following documentation describes the steps to setup IntelliJ IDEA 2019.1.3
([https://www.jetbrains.com/idea/download/](https://www.jetbrains.com/idea/download/))
with the Flink sources.
@@ -66,19 +66,20 @@ to enable support for Scala projects and files:
### Importing Flink
-1. Start IntelliJ IDEA and choose "Import Project"
-2. Select the root folder of the Flink repository
+1. Start IntelliJ IDEA and choose "New -> Project from Existing Sources"
+2. Select the root folder of the cloned Flink repository
3. Choose "Import project from external model" and select "Maven"
-4. Leave the default options and click on "Next" until you hit the SDK section.
-5. If there is no SDK, create a one with the "+" sign top left,
- then click "JDK", select your JDK home directory and click "OK".
- Otherwise simply select your SDK.
-6. Continue by clicking "Next" again and finish the import.
+4. Leave the default options and successively click "Next" until you reach the SDK section.
+5. If there is no SDK listed, create one using the "+" sign on the top left.
+ Select "JDK", choose the JDK home directory and click "OK".
+ Select the most suiting JDK version. NOTE: A good rule of thumb is to select
+ the JDK version matching the active Maven profile.
+6. Continue by clicking "Next" until finishing the import.
7. Right-click on the imported Flink project -> Maven -> Generate Sources and Update Folders.
Note that this will install Flink libraries in your local Maven repository,
- i.e. "/home/*-your-user-*/.m2/repository/org/apache/flink/".
- Alternatively, `mvn clean package -DskipTests` also creates the necessary
- files for the IDE to work with but without installing libraries.
+ located by default at "/home/$USER/.m2/repository/org/apache/flink/".
+ Alternatively, `mvn clean package -DskipTests` also creates the files necessary
+ for the IDE to work but without installing the libraries.
8. Build the Project (Build -> Make Project)
### Checkstyle For Java