Skip to content

Commit 56b1649

Browse files
authored
[chore]: bump developer guide java version (opensearch-project#908)
* chore: bump guide java version Signed-off-by: Ian Menendez <ianfmenendezd@gmail.com> * chore: java 21 on title and other parts Signed-off-by: Ian Menendez <ianfmenendezd@gmail.com> --------- Signed-off-by: Ian Menendez <ianfmenendezd@gmail.com>
1 parent 481a347 commit 56b1649

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

DEVELOPER_GUIDE.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
- [Getting Started](#getting-started)
33
- [Fork OpenSearch neural-search Repo](#fork-opensearch-neural-search-repo)
44
- [Install Prerequisites](#install-prerequisites)
5-
- [JDK 11](#jdk-11)
5+
- [JDK 21](#jdk-21)
66
- [Environment](#Environment)
77
- [Use an Editor](#use-an-editor)
88
- [IntelliJ IDEA](#intellij-idea)
@@ -33,18 +33,18 @@ git clone https://github.com/[your username]/neural-search.git
3333

3434
### Install Prerequisites
3535

36-
#### JDK 11
36+
#### JDK 21
3737

38-
OpenSearch builds using Java 11 at a minimum. This means you must have a JDK 11 installed with the environment variable
39-
`JAVA_HOME` referencing the path to Java home for your JDK 11 installation, e.g. `JAVA_HOME=/usr/lib/jvm/jdk-11`.
38+
OpenSearch builds using Java 21 at a minimum. This means you must have a JDK 21 installed with the environment variable
39+
`JAVA_HOME` referencing the path to Java home for your JDK 21 installation, e.g. `JAVA_HOME=/usr/lib/jvm/jdk-21`.
4040

41-
One easy way to get Java 11 on *nix is to use [sdkman](https://sdkman.io/).
41+
One easy way to get Java 21 on *nix is to use [sdkman](https://sdkman.io/).
4242

4343
```bash
4444
curl -s "https://get.sdkman.io" | bash
4545
source ~/.sdkman/bin/sdkman-init.sh
46-
sdk install java 11.0.2-open
47-
sdk use java 11.0.2-open
46+
sdk install java 21.0.2-open
47+
sdk use java 21.0.2-open
4848
```
4949

5050
JDK versions 14 and 17 were tested and are fully supported for local development.
@@ -53,7 +53,7 @@ JDK versions 14 and 17 were tested and are fully supported for local development
5353

5454
### IntelliJ IDEA
5555

56-
When importing into IntelliJ you will need to define an appropriate JDK. The convention is that **this SDK should be named "11"**, and the project import will detect it automatically. For more details on defining an SDK in IntelliJ please refer to [this documentation](https://www.jetbrains.com/help/idea/sdk.html#define-sdk). Note that SDK definitions are global, so you can add the JDK from any project, or after project import. Importing with a missing JDK will still work, IntelliJ will report a problem and will refuse to build until resolved.
56+
When importing into IntelliJ you will need to define an appropriate JDK. The convention is that **this SDK should be named "21"**, and the project import will detect it automatically. For more details on defining an SDK in IntelliJ please refer to [this documentation](https://www.jetbrains.com/help/idea/sdk.html#define-sdk). Note that SDK definitions are global, so you can add the JDK from any project, or after project import. Importing with a missing JDK will still work, IntelliJ will report a problem and will refuse to build until resolved.
5757

5858
You can import the OpenSearch project into IntelliJ IDEA as follows.
5959

0 commit comments

Comments
 (0)