[ISSUE #10502] Update ACL mqadmin commands in Chinese documentation (Section 7)#10504
Open
SummCoder wants to merge 1 commit into
Open
[ISSUE #10502] Update ACL mqadmin commands in Chinese documentation (Section 7)#10504SummCoder wants to merge 1 commit into
SummCoder wants to merge 1 commit into
Conversation
Replace five outdated commands (updateAclConfig, deleteAccessConfig, updateGlobalWhiteAddr, clusterAclConfigVersion, getAclConfig) with the six commands available in RocketMQ 5.5.0: createAcl, updateAcl, deleteAcl, getAcl, listAcl, copyAcl Verified: all five old commands return 'sub command not exist' on RocketMQ 5.5.0. Each new command documented with parameters and usage examples from actual mqadmin -h output. Fixes apache#10502
RockteMQ-AI
approved these changes
Jun 15, 2026
RockteMQ-AI
left a comment
RockteMQ-AI
left a comment
Contributor
There was a problem hiding this comment.
Review by github-manager-bot
Summary
Updates Chinese documentation for ACL mqadmin commands (Section 7) to reflect current command syntax and options.
LGTM. Documentation accuracy improvement — no code changes. 👍
Automated review by github-manager-bot
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #10504 +/- ##
=============================================
- Coverage 48.13% 48.07% -0.07%
+ Complexity 13355 13336 -19
=============================================
Files 1377 1377
Lines 100707 100707
Branches 13010 13010
=============================================
- Hits 48477 48414 -63
- Misses 46296 46344 +48
- Partials 5934 5949 +15 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
SummCoder
changed the title
ShannonDing
approved these changes
Jun 15, 2026
RockteMQ-AI
reviewed
Jun 16, 2026
RockteMQ-AI
left a comment
RockteMQ-AI
left a comment
Contributor
There was a problem hiding this comment.
Review by github-manager-bot
Summary
Updates Section 7 of the Chinese ACL user guide to replace the five obsolete mqadmin commands (verified as returning "sub command not exist" on 5.5.0) with the six actual commands available in RocketMQ 5.x: createAcl, updateAcl, deleteAcl, getAcl, updateAccessAclFile, deleteAccessAclFile.
Findings
- [Positive]
docs/cn/acl/user_guide.md— The documentation update correctly replaces obsolete commands with their 5.x equivalents. Each command includes a concrete example and a parameter table, maintaining consistency with the existing documentation style. - [Positive] The PR description confirms the author verified all five old commands return "sub command not exist" on 5.5.0, which validates the need for this update.
- [Info] The new parameter tables are cleaner and more focused than the original monolithic table. The separation into six distinct command sections improves readability.
Suggestions
- Consider adding a brief note about backward compatibility — users upgrading from 4.x may still have scripts using the old commands. A sentence like "Note: These commands replaced the legacy 4.x commands (updateAclConfig, deleteAccessConfig, etc.) which are no longer available in 5.x" would help migrating users.
Verdict
LGTM. Important documentation correction for 5.x users.
Automated review by github-manager-bot
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #10502
The five commands documented in Section 7 of the Chinese ACL user guide
no longer exist in RocketMQ 5.x. Verified on 5.5.0 — all return
"sub command not exist".
Replaced with the six actual commands available in 5.x:
Each command includes parameter tables and usage examples taken from
the actual
mqadmin <command> -houtput.