[GEODE-10518] blocks-2.0.0 : Update documentation for Jakarta EE 10 and Java 17 #7953
Conversation
- Update Java version format from 1.8.0_121 to 17.0.16 - Update all Geode module versions from 1.0.0 to 2.0.0 - Replace javax.transaction-api with jakarta.transaction-api 2.0.1 - Update dependency versions (slf4j 2.0.17, log4j 2.17.2, jgroups 3.6.20, fastutil 8.5.8) - Update config.yml: min_java_version='17', min_java_update='16' - Fix Java version template expressions across 20+ documentation files - Update WebLogic HTTP session management guide for Jakarta EE 10 - Update installation guides with Java 17 requirements Breaking Changes: - Minimum Java version now Java 17.0.16 (was Java 8u121) - Jakarta EE 10 required (was Java EE 8) - All javax.* packages replaced with jakarta.* Testing: - Verified peer-to-peer and client-server configurations - Documentation builds successfully - All quality checks passed (spotlessCheck, rat, checkPom, pmdMain)
|
@raboof, all checks have passed. |
JinwooHwang
changed the title
|
We are ready to merge. Please let me know if you have any concerns. Thank you very much for your support. |
JinwooHwang
changed the title
|
Please let me know if you have any questions. Thank you for your help. |
|
Thank you so much for your help, @sboorlagadda and @raboof. This is the only remaining blocker. Please let me know if you have any questions or concerns—I truly appreciate your time and guidance. Thank you again. |
Location: geode-docs/tools_modules/http_session_mgmt/quick_start.html.md.erb:66
Issue: The attribute name changed from locator to locators. This needs verification:
Location: geode-docs/tools_modules/http_session_mgmt/tomcat_installing_the_module.html.md.erb:56
Issue: The path shows .49 but earlier in the file it shows .30. While these are just examples, consistency would be better for readability.
Location: geode-docs/tools_modules/http_session_mgmt/tomcat_setting_up_the_module.html.md.erb:123 -15-Jul-2021 10:25:11.483 INFO... Issue: The year was updated to 2025, but this is output from a running system. The commit message says Java 17 is required, and the output should reflect that version number format. However, I see: Java Version: <%=vars.min_java_version%>.0.<%=vars.min_java_update%> This will render as 17.0.16 which is correct for Java 17 format (not 1.17.0_16).
Location: geode-docs/tools_modules/http_session_mgmt/quick_start.html.md.erb:55 Support for Pivotal tc Server has been removed. Users should migrate to Tomcat 10.1 or later. This line appears standalone and could be integrated better with the "Note:" style used elsewhere. Positive Aspects
Recommendations
Correctness Assessment Overall: Good with minor issues ✅ The commit correctly updates the documentation for the major version migration. The changes are internally consistent and properly reflect:
The main concern is the locator → locators attribute change which could break existing configurations and needs verification. |
|
Thank you so much for jumping in to review this, @leonfin. I really appreciate you taking the time—especially when other reviewers were unavailable. The property name must be Evidence from Codebase HistoryFrom the very beginning (commit 1709e62, June 29, 2015), public static final String LOCATORS_NAME = "locators";
public static final String LOCATOR_WAIT_TIME_NAME = "locator-wait-time";
public static final String START_LOCATOR_NAME = "start-locator";
public static final String REMOTE_LOCATORS_NAME = "remote-locators";Notice that all locator-related properties use either plural ( The Documentation ErrorWhen the documentation was first consolidated in commit ccc2fbd (October 4, 2016), someone accidentally changed Updates Based on Your ReviewI've addressed all the issues you identified:
Thank you again for your thorough review! These improvements make the documentation much clearer and more consistent. |
…te tc Server deprecation notes - Fix Tomcat version inconsistency: Changed CATALINA_HOME path from 10.1.49 to 10.1.30 to match example text - Consolidate duplicate tc Server removal messages into single Note for clarity - Improve documentation consistency and readability
|
I have implemented suggestions by @leonfin. All checks have passed. We are ready to merge. @leonfin , @sboorlagadda and @raboof, please let me know if you have any concerns or questions. Thank you very much for your support. |
2 participants
Summary
This PR updates Apache Geode documentation to reflect Jakarta EE 10 compatibility and Java 17 requirements for version 2.0.
Motivation
Apache Geode 2.0 introduces breaking changes due to:
javax.*) to Jakarta EE 10 (jakarta.*)The documentation needs to be updated to reflect these changes and provide clear migration guidance for users.
Changes
1. Java Version Format Update
Problem: Documentation used Java 8 version format (
1.8.0_121) which is incompatible with Java 17 versioning (17.0.16).Solution: Updated all documentation to use Java 17 version format.
Template Variables Updated
File:
geode-book/config.ymlThis produces the version string:
17.0.16Template Expression Updates
1.<%=vars.min_java_version%>.0_<%=vars.min_java_update%>→ produces1.17.0_121<%=vars.min_java_version%>.0.<%=vars.min_java_update%>→ produces17.0.16Files Modified (20+ occurrences)
configuring/cluster_config/persisting_configurations.html.md.erb(7 occurrences)getting_started/15_minute_quickstart_gfsh.html.md.erb(2 occurrences)getting_started/installation/install_standalone.html.md.erb(4 occurrences)managing/management/jmx_manager_operations.html.md.erb(1 occurrence)configuring/running/running_the_locator.html.md.erb(1 occurrence)configuring/running/running_the_cacheserver.html.md.erb(1 occurrence)tools_modules/http_session_mgmt/tc_additional_info.html.md.erb(1 occurrence)tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb(1 occurrence)tools_modules/gfsh/tour_of_gfsh.html.md.erb(3 occurrences)tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb(1 occurrence)Examples of changes:
Java Version: 17.0.16(was1.8.0_121)/usr/java/jdk-17.0.16(was/usr/java/jdk1.8.0_121)17.0.16(was1.8.0_121)2. JAR Version Updates
Problem: Documentation referenced Geode 1.0.0 JAR files which are outdated for version 2.0.
Solution: Updated all JAR version references from
1.0.0to2.0.0.Files Modified (4 occurrences)
getting_started/15_minute_quickstart_gfsh.html.md.erbgeode-core-1.0.0.jar→geode-core-2.0.0.jar(2 occurrences)tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erbgeode-modules-1.0.0.jar→geode-modules-2.0.0.jargeode-modules-tomcat8-1.0.0.jar→geode-modules-tomcat8-2.0.0.jar3. WebLogic HTTP Session Management Documentation
File:
tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erbProblem: Manifest Class-Path and startup examples contained incorrect JAR versions and outdated Java EE dependencies.
Solution: Updated to Jakarta EE 10 dependencies and Geode 2.0 module versions.
Key Dependency Changes
Documentation Build Verification
Impact Assessment
Documentation Impact
User Impact
javax.*) applications must migrate to Jakarta EE 10 (jakarta.*)Compatibility
Files Modified
Related Issues
doc2.0branchFor all changes, please confirm:
develop)?gradlew buildrun cleanly?