From bbb14285f0054adfa532e818bd8e93e125375cd2 Mon Sep 17 00:00:00 2001 From: Matthias Pohl Date: Tue, 20 Apr 2021 11:48:02 +0200 Subject: [PATCH] [FLINK-21106][docs] Updates Flink docs to refer to the plugin's page google-java-format plugin 1.7.0.6 was released (https://github.com/google/google-java-format/issues/560). Hence, we do not have to rely on the patched version of FLINK-21106 anymore. --- docs/content.zh/docs/flinkDev/ide_setup.md | 5 ++--- docs/content/docs/flinkDev/ide_setup.md | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/content.zh/docs/flinkDev/ide_setup.md b/docs/content.zh/docs/flinkDev/ide_setup.md index e20918b65c930..28ef3055364d7 100644 --- a/docs/content.zh/docs/flinkDev/ide_setup.md +++ b/docs/content.zh/docs/flinkDev/ide_setup.md @@ -99,13 +99,12 @@ to enable support for Scala projects and files: We use the [Spotless plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together with [google-java-format](https://github.com/google/google-java-format) to -format our Java code. Due to [FLINK-21106](https://issues.apache.org/jira/browse/FLINK-21106) a -specific, patched version of the plugin is needed to work correctly with IntelliJ. +format our Java code. You can configure your IDE to automatically apply formatting on saving with these steps: 1. Download the [google-java-format - plugin v1.7.0.5](https://issues.apache.org/jira/secure/attachment/13019264/google-java-format-1.7-patched.zip). + plugin v1.7.0.6](https://plugins.jetbrains.com/plugin/8527-google-java-format/versions/stable/115957). 2. Open Settings → Plugins, click on the gear icon and select "Install Plugin from Disk". Navigate to the downloaded zip file and select it. 3. In the plugin settings, enable the plugin and change the code style to "AOSP" (4-space indents). 4. Remember to never update this plugin to a later version! diff --git a/docs/content/docs/flinkDev/ide_setup.md b/docs/content/docs/flinkDev/ide_setup.md index 250b1188a902a..644759bc31eb4 100644 --- a/docs/content/docs/flinkDev/ide_setup.md +++ b/docs/content/docs/flinkDev/ide_setup.md @@ -99,13 +99,12 @@ to enable support for Scala projects and files: We use the [Spotless plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together with [google-java-format](https://github.com/google/google-java-format) to -format our Java code. Due to [FLINK-21106](https://issues.apache.org/jira/browse/FLINK-21106) a -specific, patched version of the plugin is needed to work correctly with IntelliJ. +format our Java code. You can configure your IDE to automatically apply formatting on saving with these steps: 1. Download the [google-java-format - plugin v1.7.0.5](https://issues.apache.org/jira/secure/attachment/13019264/google-java-format-1.7-patched.zip). + plugin v1.7.0.6](https://plugins.jetbrains.com/plugin/8527-google-java-format/versions/stable/115957). 2. Open Settings → Plugins, click on the gear icon and select "Install Plugin from Disk". Navigate to the downloaded zip file and select it. 3. In the plugin settings, enable the plugin and change the code style to "AOSP" (4-space indents). 4. Remember to never update this plugin to a later version!