Skip to content

[FLINK-21106][docs] Updates Flink docs to refer to the plugin's page #15685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zentol merged 1 commit into from
Apr 20, 2021
Merged

[FLINK-21106][docs] Updates Flink docs to refer to the plugin's page #15685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/content.zh/docs/flinkDev/ide_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
5 changes: 2 additions & 3 deletions docs/content/docs/flinkDev/ide_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down