You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by "rangareddy (via GitHub)" <gi...@apache.org> on 2025/10/24 11:20:52 UTC

[PR] chore: Update Hudi table version mapping and downgrade examples in Hudi CLI documentation [hudi]

rangareddy opened a new pull request, #14152:
URL: https://github.com/apache/hudi/pull/14152

   ### Describe the issue this Pull Request addresses
   
   The documentation for Hudi's CLI table downgrade functionality contained outdated and potentially confusing examples. Specifically, the examples used old and unrealistic target table versions (like version TWO) that are unlikely to be relevant for users of recent Hudi releases (0.14.x, 0.15.x, 1.0.x).
   
   <!-- Either describe the issue inline here with motivation behind the changes 
        (or) link to an issue by including `Closes #<issue-number>` for context. 
        If this PR includes changes to the storage format, public APIs,
        or has breaking changes, use `!` (e.g., feat!: ...) -->
   
   ### Summary and Changelog
   
   This PR clarifies and updates the Hudi CLI documentation regarding table versioning, ensuring the provided examples reflect current best practices and available versions.
   
   **Summary:**
   
   Updated Hudi CLI documentation files to include the latest table version mappings (up to version EIGHT) and revised all downgrade examples to target realistic, modern Hudi versions. This prevents user confusion and makes the documentation more practical.
   
   **Changelog:**
   
   The changes include:
   - Added missing table versions SIX (0.14.x-0.15.x) and EIGHT (1.0.x)
   - Updated downgrade examples to use realistic target versions:
       - 1.0.x → downgrade to SIX (6) instead of TWO (2)
       - 0.14.x/0.15.x → downgrade to FIVE (5) instead of TWO (2)
   - Updated properties examples to match the downgrade targets
   - Applied changes across all versioned documentation files
   
   <!-- Short, plain-English summary of what users gain or what changed in behavior.
        Followed by a detailed log of all the changes. Highlight if any code was copied. -->
   
   ### Impact
   
   The impact is strictly related to the clarity and accuracy of the Hudi website documentation.
   <!-- Describe any public API or user-facing feature change or any performance impact. -->
   
   ### Risk Level
   
   none
   
   This change is purely a documentation update to correct misleading information and add missing context. It does not touch any source code or configuration that affects runtime behavior.
   <!-- Accepted values: none, low, medium or high. Other than `none`, explain the risk.
        If medium or high, explain what verification was done to mitigate the risks. -->
   
   ### Documentation Update
   
   This PR completes the necessary documentation update by correcting the existing CLI documentation files related to table versioning and downgrade commands.
   <!-- Describe any necessary documentation update if there is any new feature, config, or user-facing change. If not, put "none".
   
   - The config description must be updated if new configs are added or the default value of the configs are changed.
   - Any new feature or user-facing change requires updating the Hudi website. Please follow the 
     [instruction](https://hudi.apache.org/contribute/developer-setup#website) to make changes to the website. -->
   
   ### Contributor's checklist
   
   - [x] Read through [contributor's guide](https://hudi.apache.org/contribute/how-to-contribute)
   - [x] Enough context is provided in the sections above
   - [x] Adequate tests were added if applicable
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: update Hudi table version mapping and downgrade examples in CLI [hudi]

Posted by "xushiyan (via GitHub)" <gi...@apache.org>.
xushiyan merged PR #14152:
URL: https://github.com/apache/hudi/pull/14152


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org