This is an automated email from the ASF dual-hosted git repository.
yihua 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 878785bc65c [DOCS][HUDI-8012] Update docs on checkstyle configuration
in IDE setup (#11759)
878785bc65c is described below
commit 878785bc65cd5d8f4944f8b420d5380a67e1cfea
Author: Y Ethan Guo <[email protected]>
AuthorDate: Mon Aug 12 11:39:55 2024 -0700
[DOCS][HUDI-8012] Update docs on checkstyle configuration in IDE setup
(#11759)
---
website/contribute/developer-setup.md | 16 ++++++++--------
.../images/contributing/IDE_setup_checkstyle_1.png | Bin 323973 -> 262795 bytes
.../images/contributing/IDE_setup_checkstyle_2.png | Bin 254971 -> 304546 bytes
.../images/contributing/IDE_setup_checkstyle_3.png | Bin 277777 -> 668674 bytes
.../images/contributing/IDE_setup_checkstyle_4.png | Bin 683055 -> 292288 bytes
.../IDE_setup_code_style_java_after.png | Bin 149713 -> 368410 bytes
.../IDE_setup_code_style_java_before.png | Bin 168110 -> 420130 bytes
7 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/website/contribute/developer-setup.md
b/website/contribute/developer-setup.md
index 4b80cee3e15..dc19bb222c3 100644
--- a/website/contribute/developer-setup.md
+++ b/website/contribute/developer-setup.md
@@ -3,7 +3,7 @@ title: Developer Setup
sidebar_position: 4
keywords: [ hudi, ide, developer, setup]
toc: true
-last_modified_at: 2019-12-30T15:59:57-04:00
+last_modified_at: 2024-08-12T10:47:57-07:00
---
## Pre-requisites
@@ -47,24 +47,24 @@ 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 IntelliJ
+ * Open `Settings` in IntelliJ
* Install and activate CheckStyle plugin
- * Open Preferences -> Tools -> checkstyle
+ * In `Settings` > `Tools` > `Checkstyle`, use a recent version, e.g.,
10.17.0
- * Change checkstyle version to 8.20
+ * Click on `+`, add the style/checkstyle.xml file, and name the
configuration as "Hudi Checks"
- * Click on + and add the style/checkstyle.xml file
+ * Activate the checkstyle configuration by checking `Active`
- * Open Preferences -> Editor -> Code Style -> Java
- * Select "Project" as the "Scheme". Then, go to the settings, open
"Import Scheme" -> "CheckStyle Configuration", select `style/checkstyle.xml` to
load
+ * Open `Settings` > `Editor` > `Code Style` > `Java`
+ * Select "Project" as the "Scheme". Then, go to the settings, open
`Import Scheme` > `CheckStyle Configuration`, select `style/checkstyle.xml` to
load
- * After loading the configuration, you should see that the "Indent" and
"Continuation indent" become 2 and 4, from 4 and 8, respectively
+ * After loading the configuration, you should see that the `Indent` and
`Continuation indent` become 2 and 4, from 4 and 8, respectively
* Apply/Save the changes
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_1.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_1.png
index 0c1d33ae244..7de5ba99a35 100644
Binary files
a/website/static/assets/images/contributing/IDE_setup_checkstyle_1.png and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_1.png differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_2.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_2.png
index 08c04b4705b..bf624ce1d4a 100644
Binary files
a/website/static/assets/images/contributing/IDE_setup_checkstyle_2.png and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_2.png differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_3.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_3.png
index a1909a11a97..61adb275e69 100644
Binary files
a/website/static/assets/images/contributing/IDE_setup_checkstyle_3.png and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_3.png differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_4.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_4.png
index a85d2e11250..f962c5c0ed0 100644
Binary files
a/website/static/assets/images/contributing/IDE_setup_checkstyle_4.png and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_4.png differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_code_style_java_after.png
b/website/static/assets/images/contributing/IDE_setup_code_style_java_after.png
index db58aea843a..ef3dfbee61f 100644
Binary files
a/website/static/assets/images/contributing/IDE_setup_code_style_java_after.png
and
b/website/static/assets/images/contributing/IDE_setup_code_style_java_after.png
differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_code_style_java_before.png
b/website/static/assets/images/contributing/IDE_setup_code_style_java_before.png
index c259c409b06..ecdb0fa464a 100644
Binary files
a/website/static/assets/images/contributing/IDE_setup_code_style_java_before.png
and
b/website/static/assets/images/contributing/IDE_setup_code_style_java_before.png
differ
