[GitHub] [flink] tillrohrmann commented on a change in pull request #13165: [FLINK-18963][docs] Introduced IntelliJ subsection about adding a Copyright Profile for the Apache license.

[GitBox <gi...@apache.org>]

tillrohrmann commented on a change in pull request #13165:
URL: https://github.com/apache/flink/pull/13165#discussion_r471297154



##########
File path: docs/flinkDev/ide_setup.md
##########
@@ -117,6 +117,32 @@ Nevertheless please make sure that code you add/modify in these modules still co
 
 Enable scalastyle in Intellij by selecting Settings -> Editor -> Inspections, then searching for "Scala style inspections". Also Place `"tools/maven/scalastyle-config.xml"` in the `"<root>/.idea"` or `"<root>/project"` directory.
 
+### Copyright Profile
+
+Each file needs to include the Apache license as a header. This can be automated in IntelliJ by adding a Copyright profile:
+1. Open settings
+2. Go to Editor -> Copyright -> Copyright Profiles
+3. Add a new profile naming it `Apache`
+4. Add the following text as the license text:
+```

Review comment:
       Missing line break before the backticks.

##########
File path: docs/flinkDev/ide_setup.zh.md
##########
@@ -117,6 +117,32 @@ Nevertheless please make sure that code you add/modify in these modules still co
 
 Enable scalastyle in Intellij by selecting Settings -> Editor -> Inspections, then searching for "Scala style inspections". Also Place `"tools/maven/scalastyle-config.xml"` in the `"<root>/.idea"` or `"<root>/project"` directory.
 
+### Copyright Profile
+
+Each file needs to include the Apache license as a header. This can be automated in IntelliJ by adding a Copyright profile:
+1. Open settings
+2. Go to Editor -> Copyright -> Copyright Profiles
+3. Add a new profile naming it `Apache`
+4. Add the following text as the license text:
+```

Review comment:
       Same here.

##########
File path: docs/flinkDev/ide_setup.md
##########
@@ -117,6 +117,32 @@ Nevertheless please make sure that code you add/modify in these modules still co
 
 Enable scalastyle in Intellij by selecting Settings -> Editor -> Inspections, then searching for "Scala style inspections". Also Place `"tools/maven/scalastyle-config.xml"` in the `"<root>/.idea"` or `"<root>/project"` directory.
 
+### Copyright Profile
+
+Each file needs to include the Apache license as a header. This can be automated in IntelliJ by adding a Copyright profile:
+1. Open settings
+2. Go to Editor -> Copyright -> Copyright Profiles
+3. Add a new profile naming it `Apache`
+4. Add the following text as the license text:
+```
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+   
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and 
+limitations under the License.
+```
+5. Apply the changes.

Review comment:
       This ordered list point does not appear with `5. Apply the changes` but `1. Apply the changes`.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org