Jinwoo Hwang created GEODE-10488:
------------------------------------
Summary: Update geode-book documentation configuration and content
for Apache Geode 2.0.0 release
Key: GEODE-10488
URL: https://issues.apache.org/jira/browse/GEODE-10488
Project: Geode
Issue Type: Improvement
Reporter: Jinwoo Hwang
Comprehensively update the entire geode-book documentation system in the Geode
repository to reflect the new 2.0.0 major release, including configuration
files, content updates, and build system modifications.
h3. Background
The Apache Geode documentation is built using the geode-book system, which
includes multiple configuration files, content directories, and build
processes. For the major 2.0.0 release, all components of geode-book need to be
updated to ensure:
* Correct version numbers appear throughout all documentation
* New features and breaking changes in 2.0.0 are properly documented
* Build system works correctly for the new major version
* All cross-references and navigation work properly
* Documentation structure supports the 2.x series going forward
h3. Tasks:
h4. 1. Configuration Updates
* Update {{geode-book/config.yml}} with 2.0.0 version information
* Review and update any other YAML configuration files in geode-book/
* Update build scripts and automation
* Verify book metadata, titles, and version-dependent configurations
h4. 2. Content Review and Updates
* Review all markdown files in geode-book/master_middleman/source/ for
version-specific content
* Update code examples and snippets that reference version numbers
* Add documentation for new 2.0.0 features
* Update or mark deprecated features from previous versions
* Review breaking changes and update relevant documentation sections
h4. 3. Navigation and Structure
* Update table of contents and navigation files
* Verify all internal links and cross-references work with 2.0.0
* Update any hardcoded version references in templates
* Review and update getting started guides for 2.0.0
h4. 4. Build System Validation
* Test full documentation build process with updated configurations
* Verify all output formats generate correctly
* Test link validation and cross-reference integrity
* Ensure build performance is acceptable for 2.x series
h4. 5. Version-Specific Content
* Create/update 2.0.0 release notes within documentation
* Update installation and upgrade guides for 2.0.0
* Review and update API documentation references
* Update compatibility matrices and version tables
h4. 6. Template and Layout Updates
* Review and update any template files with version information
* Update headers, footers, and navigation elements
* Verify responsive design works with updated content
* Update any version-dependent styling or layouts
h3. Files/Directories to Review:
* {{geode-book/config.yml}} (primary configuration)
* {{geode-book/master_middleman/source/}} (all content files)
* {{geode-book/Rakefile}} and build scripts
* {{geode-book/Gemfile}} and dependencies
* Any template files in geode-book/
* Version-specific content and examples throughout
h3. Specific Changes Required:
* Update all version references from previous versions to 2.0.0
* Add major version handling for 2.x series
* Update product version references in all content
* Verify book titles and metadata reflect correct major version
* Update template variables and substitutions for 2.x compatibility
* Review and update all code examples and configuration samples
h3. Acceptance Criteria:
* All geode-book configuration files contain correct 2.0.0 version information
* Documentation builds successfully without errors or warnings
* Generated documentation displays "2.0.0" consistently throughout
* All internal links, cross-references, and navigation work correctly
* New 2.0.0 features are properly documented
* Breaking changes and deprecations are clearly marked
* Code examples and configuration samples are updated for 2.0.0
* Build process is optimized for 2.x series maintenance
* No hardcoded references to 1.x versions remain anywhere
h3. Testing Requirements:
* Full build test on clean environment
* Link validation across all generated documentation
* Cross-browser testing of generated HTML
* Performance testing of build process
* Validation of search functionality with updated content
h3. References:
* Apache Geode 2.0.0 release branch
* Previous major version documentation updates for reference
* geode-book build system documentation
* Apache Geode 2.0.0 release notes and feature list
* Breaking changes documentation for 2.0.0
h3. Dependencies:
* Apache Geode 2.0.0 release branch created and stable
* Access to modify all files in the geode-book directory
* Understanding of the complete geode-book build system
* Coordination with release management for 2.0.0 feature list
* Review of all breaking changes and new features in 2.0.0
h3. Notes:
This is a comprehensive major version update affecting the entire documentation
system. Special attention should be paid to:
* Consistency of version formatting across all files
* Proper handling of major version implications throughout
* Backward compatibility considerations in documentation structure
* Future maintainability for the 2.x series
* Integration with the geode-site publishing process
h3. Estimated Effort:
This task involves reviewing and potentially updating hundreds of files across
the entire geode-book documentation system, making it a significant undertaking
requiring careful planning and systematic execution.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
