This is an automated email from the ASF dual-hosted git repository.
sivabalan pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hudi.git
The following commit(s) were added to refs/heads/asf-site by this push:
new f1734f574dc [DOCS][HUDI-6529] Update developer setup page (#9192)
f1734f574dc is described below
commit f1734f574dc896aa9b2cf0cf1ee01aef90628aa3
Author: Y Ethan Guo <[email protected]>
AuthorDate: Thu Jul 13 23:17:03 2023 -0700
[DOCS][HUDI-6529] Update developer setup page (#9192)
---
website/contribute/developer-setup.md | 25 +++++++++++++++------
.../images/contributing/IDE_setup_annotation.png | Bin 0 -> 318314 bytes
.../assets/images/contributing/IDE_setup_java.png | Bin 0 -> 134352 bytes
.../images/contributing/IDE_setup_maven_1.png | Bin 608854 -> 157576 bytes
.../images/contributing/IDE_setup_reload.png | Bin 0 -> 242712 bytes
5 files changed, 18 insertions(+), 7 deletions(-)
diff --git a/website/contribute/developer-setup.md
b/website/contribute/developer-setup.md
index 9202c3c2ba9..5ca759250d6 100644
--- a/website/contribute/developer-setup.md
+++ b/website/contribute/developer-setup.md
@@ -26,6 +26,24 @@ To contribute, you would need to do the following
- Fork the Hudi code on Github & then clone your own fork locally. Once
cloned, we recommend building as per instructions on [spark
quickstart](/docs/quick-start-guide) or [flink
quickstart](/docs/flink-quick-start-guide)
+- In `Project Structure`, select Java 1.8 as the Project SDK
+
+ 
+
+- Make the following configuration in `Preferences` or `Settings` in newer
IntelliJ so the Hudi code can compile in the IDE:
+ * Enable annotation processing in compiler
+
+ 
+ * Configure Maven *NOT* to delegate IDE build/run actions to Maven so you
can run tests in IntelliJ directly
+
+ 
+ 
+
+- If you switch maven build profile, e.g., from Spark 3.2 to Spark 3.3, you
need to first build Hudi in the command line first and `Reload All Maven
Projects` in IntelliJ like below,
+so that IntelliJ re-indexes the code
+
+ 
+
- \[Recommended\] We have embraced the code style largely based on [google
format](https://google.github.io/styleguide/javaguide.html). Please set up your
IDE with style files from [\<project
root\>/style/](https://github.com/apache/hudi/tree/master/style). These
instructions have been tested on IntelliJ.
* Open Project Preferences in IDE
* Install and activate CheckStyle plugin
@@ -55,13 +73,6 @@ To contribute, you would need to do the following
-- \[Optional\] If needed, add spark jars to the classpath of your module in
Intellij by following the steps from
[here](https://stackoverflow.com/questions/1051640/correct-way-to-add-external-jars-lib-jar-to-an-intellij-idea-project).
-
-- \[Optional\] You may configure IntelliJ to respect maven CLI and pom.xml
settings.
-
-
-
-
## Accounts and Permissions
- [Hudi issue tracker
(JIRA)](https://issues.apache.org/jira/projects/HUDI/issues):
diff --git a/website/static/assets/images/contributing/IDE_setup_annotation.png
b/website/static/assets/images/contributing/IDE_setup_annotation.png
new file mode 100644
index 00000000000..7646a438cd1
Binary files /dev/null and
b/website/static/assets/images/contributing/IDE_setup_annotation.png differ
diff --git a/website/static/assets/images/contributing/IDE_setup_java.png
b/website/static/assets/images/contributing/IDE_setup_java.png
new file mode 100644
index 00000000000..9eef94b9148
Binary files /dev/null and
b/website/static/assets/images/contributing/IDE_setup_java.png differ
diff --git a/website/static/assets/images/contributing/IDE_setup_maven_1.png
b/website/static/assets/images/contributing/IDE_setup_maven_1.png
index 6e500e1acc6..428b303bee6 100644
Binary files a/website/static/assets/images/contributing/IDE_setup_maven_1.png
and b/website/static/assets/images/contributing/IDE_setup_maven_1.png differ
diff --git a/website/static/assets/images/contributing/IDE_setup_reload.png
b/website/static/assets/images/contributing/IDE_setup_reload.png
new file mode 100644
index 00000000000..89e73a4e1d2
Binary files /dev/null and
b/website/static/assets/images/contributing/IDE_setup_reload.png differ
