opensearch-project / opensearch-project/OpenSearch

[DOCS] DEVELOPER_GUIDE about JDK-17

Open
#9,348 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation
Dominant language
Java
Stars
13.7k
Forks
3k
Avg merge
2d 23h
Merged PRs (30d)
108

Description

The DEVELOPER_GUIDE.md -> Install Prerequisites -> JDK-17 mentions bundled JDK version. It also points to buildSrc/version.properties and contains a short snippet from that file. But it is outdated.

As of writing the version of bundled JDK is set to 20.x

Shall the DEVELOPER_GUIDE.md be updated or reformulated to not mention specific JDK version?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the JDK-17 section in DEVELOPER_GUIDE.md and compare its bundled JDK details with buildSrc/version.properties. Decide whether the guide should reflect the current version or avoid specifying one, then update the documentation so its prerequisite guidance matches the source and no longer contains outdated details.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.