You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/04/26 04:17:04 UTC

[GitHub] [pulsar] lhotari opened a new pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

lhotari opened a new pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371


   ### Motivation
   
   Currently Java 8 is recommended for Pulsar development. The IntelliJ setup instructions don't currently include the configuration of the Project JDK. It would be helpful to document this.
   
   Java 11 support for building Pulsar in currently being improved. The side effect of this is that some of the configuration is dynamically chosen based on the JDK version. If the JDK version used for importing in IntelliJ is Java 11, and development is done on Java 8, this will lead to inconsistencies and errors about invalid parameters `--add-opens java.base/jdk.internal.loader=ALL-UNNAMED` in tests since the parameters were chosen at import time when running on Java 11.
   
   ### Modifications
   
   - update IntelliJ IDE setup instructions in README.md
   - remove duplicated IDE setup instructions in `site2/website/contributing.md`


-- 
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



[GitHub] [pulsar] lhotari commented on pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
lhotari commented on pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#issuecomment-828203851


   @Anonymitaet @Huanli-Meng Thanks for the review feedback and edit suggestions. PTAL


-- 
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



[GitHub] [pulsar] Anonymitaet commented on a change in pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#discussion_r621748149



##########
File path: site2/website/contributing.md
##########
@@ -118,43 +118,10 @@ these two remotes for pushing changes).
 
 You are now ready to start developing!
 
-#### [Optional] IDE Setup
+#### IDE Setup
 
-Depending on your preferred development environment, you may need to prepare it to develop Pulsar code.
+Please find the [instructions for IDE Setup in the README.md](https://github.com/apache/pulsar/#setting-up-your-ide) file. 

Review comment:
       ```suggestion
   For how to set up IDE, see [here](https://github.com/apache/pulsar/blob/master/README.md#setting-up-your-ide). 
   ```

##########
File path: README.md
##########
@@ -136,6 +136,27 @@ required plugins.
 
 ### Intellij
 
+#### Configure Project JDK to Java 8 (1.8) JDK
+
+1. Open Project Settings dialog by going to  
+   `File -> Project Structure -> Project Settings -> Project`.
+   
+2. Click on the JDK version drop down and select `Download JDK...` or choose an existing recent Java 8 (1.8) JDK version.

Review comment:
       ```suggestion
   2. Select the JDK version.
       
       From the JDK version drop-down list, select **Download JDK...** or choose an existing recent Java 8 (1.8) JDK version.
   ```

##########
File path: README.md
##########
@@ -136,6 +136,27 @@ required plugins.
 
 ### Intellij
 
+#### Configure Project JDK to Java 8 (1.8) JDK
+
+1. Open Project Settings dialog by going to  
+   `File -> Project Structure -> Project Settings -> Project`.

Review comment:
       ```suggestion
   1. Open **Project Settings**. 
   
       Click **File** -> **Project Structure** -> **Project Settings** -> **Project**.
   ```

##########
File path: README.md
##########
@@ -136,6 +136,27 @@ required plugins.
 
 ### Intellij
 
+#### Configure Project JDK to Java 8 (1.8) JDK
+
+1. Open Project Settings dialog by going to  
+   `File -> Project Structure -> Project Settings -> Project`.

Review comment:
       In technical writing, normally, we use "bold" for buttons instead of "code style" (``).
   Please check all occurencies. 




-- 
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



[GitHub] [pulsar] lhotari commented on pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
lhotari commented on pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#issuecomment-828295185


   /pulsarbot run-failure-checks


-- 
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



[GitHub] [pulsar] lhotari commented on a change in pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
lhotari commented on a change in pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#discussion_r620419992



##########
File path: README.md
##########
@@ -136,6 +136,27 @@ required plugins.
 
 ### Intellij
 
+#### Configure Project JDK to Java 8 (1.8) JDK
+
+1. Open Project Settings dialog by going to  
+   `File -> Project Structure -> Project Settings -> Project`.
+   
+2. Click on the JDK version drop down and select `Download JDK...` or choose an existing recent Java 8 (1.8) JDK version.
+
+3. In the download dialog, select version `1.8` and vendor `AdoptOpenJDK (Hotspot)` for the JDK to download.

Review comment:
       I have rephrased the wording to address your comment. PTAL




-- 
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



[GitHub] [pulsar] lhotari commented on pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
lhotari commented on pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#issuecomment-826640048


   /pulsarbot run-failure-checks


-- 
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



[GitHub] [pulsar] eolivelli commented on a change in pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
eolivelli commented on a change in pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#discussion_r620118743



##########
File path: README.md
##########
@@ -136,6 +136,27 @@ required plugins.
 
 ### Intellij
 
+#### Configure Project JDK to Java 8 (1.8) JDK
+
+1. Open Project Settings dialog by going to  
+   `File -> Project Structure -> Project Settings -> Project`.
+   
+2. Click on the JDK version drop down and select `Download JDK...` or choose an existing recent Java 8 (1.8) JDK version.
+
+3. In the download dialog, select version `1.8` and vendor `AdoptOpenJDK (Hotspot)` for the JDK to download.

Review comment:
       I am not sure we should suggest a particular distribution.
   I like AdoptOpenJDK but it is not required




-- 
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



[GitHub] [pulsar] lhotari commented on pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
lhotari commented on pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#issuecomment-828354678


   /pulsarbot run-failure-checks


-- 
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



[GitHub] [pulsar] lhotari removed a comment on pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
lhotari removed a comment on pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#issuecomment-826640048


   /pulsarbot run-failure-checks


-- 
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



[GitHub] [pulsar] eolivelli merged pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
eolivelli merged pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371


   


-- 
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



[GitHub] [pulsar] Huanli-Meng commented on a change in pull request #10371: [Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ

Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on a change in pull request #10371:
URL: https://github.com/apache/pulsar/pull/10371#discussion_r621763302



##########
File path: README.md
##########
@@ -136,6 +136,27 @@ required plugins.
 
 ### Intellij
 
+#### Configure Project JDK to Java 8 (1.8) JDK
+
+1. Open Project Settings dialog by going to  
+   `File -> Project Structure -> Project Settings -> Project`.
+   
+2. Click on the JDK version drop down and select `Download JDK...` or choose an existing recent Java 8 (1.8) JDK version.
+
+3. In the download dialog, select version `1.8`. You can pick from many vendors. Unless you have a specific preference, choose  `AdoptOpenJDK (Hotspot)`.

Review comment:
       ```suggestion
   3. In the download dialog, select version `1.8`. You can pick a version from many vendors. Unless you have a specific preference, choose `AdoptOpenJDK (Hotspot)`.
   ```




-- 
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