Skip to content

Conversation

@JinwooHwang
Copy link
Contributor

Description

This PR updates the Apache Geode documentation to reflect the minimum Java version requirement change from Java 8 to Java 17.

Changes

Documentation Updates

  1. geode-book/config.yml

    • Updated min_java_version from '8' to '17'
    • Updated min_java_update from '121' to '16'
    • Updated product_version from '1.15' to '2.0'
    • Updated product_version_nodot from '115' to '20'
    • Updated product_version_old_minor from '1.14' to '1.15'
    • Updated documentation directory path from docs/guide/115 to docs/guide/20
  2. geode-docs/getting_started/installation/install_standalone.html.md.erb

    • Updated Java path format from jdk1.8.0_121 to jdk-17.0.16 (modern Java versioning)
    • Updated all JAVA_HOME examples for Unix/Linux platforms
    • Updated all JAVA_HOME examples for Windows platforms

Files Modified

  • geode-book/config.yml
  • geode-docs/getting_started/installation/install_standalone.html.md.erb

Files Using Template Variables (Automatically Updated)

The following files use <%=vars.min_java_version%> and <%=vars.min_java_update%> variables and will automatically reflect the Java 17 requirement:

  • geode-docs/getting_started/system_requirements/host_machine.html.md.erb
  • geode-docs/getting_started/15_minute_quickstart_gfsh.html.md.erb
  • geode-docs/configuring/cluster_config/persisting_configurations.html.md.erb
  • geode-docs/configuring/running/running_the_locator.html.md.erb
  • geode-docs/configuring/running/running_the_cacheserver.html.md.erb

Testing

  • Documentation builds successfully without broken links
  • Preview server confirms Java 17.0.16 is displayed in all examples
  • Path format correctly uses modern Java versioning (jdk-17.x instead of jdk1.8.x)
  • All references to Java versions are consistent across documentation

Preview

After these changes, the documentation will show:

  • Minimum Java Version: Java SE Development Kit 17 with update 16 or higher
  • JAVA_HOME Examples:
    • Unix/Linux: /usr/java/jdk-17.0.16
    • Windows: C:\Program Files\Java\jdk-17.0.16

Related

  • Aligns with Apache Geode 2.0 release requirements
  • Part of Jakarta EE migration effort

For all changes, please confirm:

  • Is there a JIRA ticket associated with this PR? Is it referenced in the commit message?
  • Has your PR been rebased against the latest commit within the target branch (typically develop)?
  • Is your initial contribution a single, squashed commit?
  • Does gradlew build run cleanly?
  • Have you written or updated unit tests to verify your changes?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?

- Update config.yml to require Java 17.16 minimum
- Update product version to 2.0
- Change Java path format from jdk1.8.0_121 to jdk-17.0.16
- Update install_standalone.html.md.erb with modern Java versioning
@JinwooHwang JinwooHwang requested a review from raboof November 20, 2025 19:36
@JinwooHwang
Copy link
Contributor Author

Thank you so much for your review and approval, @raboof. We are ready to merge.

@JinwooHwang
Copy link
Contributor Author

All checks have passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants