Skip to content
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.

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

[Documentation] Document the configuration of Project JDK and Maven JDK in IntelliJ #10371

Merged
merged 7 commits into from
Apr 28, 2021

Conversation

lhotari
Copy link
Member

@lhotari lhotari commented Apr 26, 2021

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

README.md Outdated Show resolved Hide resolved
Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!
I've left some comments, PTAL.

site2/website/contributing.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Anonymitaet Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Apr 28, 2021
README.md Outdated Show resolved Hide resolved
lhotari and others added 5 commits April 28, 2021 09:58
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
Co-authored-by: Huanli Meng <48120384+Huanli-Meng@users.noreply.github.com>
@lhotari
Copy link
Member Author

lhotari commented Apr 28, 2021

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

Copy link
Contributor

@Huanli-Meng Huanli-Meng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lhotari
Copy link
Member Author

lhotari commented Apr 28, 2021

/pulsarbot run-failure-checks

1 similar comment
@lhotari
Copy link
Member Author

lhotari commented Apr 28, 2021

/pulsarbot run-failure-checks

@eolivelli eolivelli merged commit 9e8949b into apache:master Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants