Document mmctl roles list (v11.7.0)#8965
Conversation
Add reference entry for the new `mmctl roles list` subcommand introduced in mattermost/mattermost#34064 (milestone v11.7.0). Description follows the PR-evidence-safe wording; permission note links the existing local mode anchor; child-specific Options block omitted since the exact help string was not in PR evidence. Resolves #8964. Co-authored-by: Combs7th <Combs7th@users.noreply.github.com>
📝 WalkthroughWalkthroughThis PR adds documentation for the Changesmmctl roles list command documentation
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@source/administration-guide/manage/mmctl-command-line-tool.rst`:
- Around line 5753-5755: Replace the `.. note::` admonition used for the command
access prerequisite with an `.. important::` admonition so the requirement
("This command requires system admin privileges, or `local mode
<#local-mode>`__.") is elevated; locate the block containing that text (the
markdown/admonition starting with `.. note::` and change the directive token to
`.. important::`, preserving the indented content and link text exactly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7ebeaf88-cfbc-45b8-a526-957c33e2df92
📒 Files selected for processing (1)
source/administration-guide/manage/mmctl-command-line-tool.rst
| .. note:: | ||
|
|
||
| This command requires system admin privileges, or `local mode <#local-mode>`__. |
There was a problem hiding this comment.
Use an important admonition for this access prerequisite.
This block describes a hard requirement to run the command, so it should be elevated from .. note:: to .. important::.
Suggested minimal diff
-.. note::
+.. important::
- This command requires system admin privileges, or `local mode <#local-mode>`__.
+ This command requires system admin privileges, or `local mode <#local-mode>`__.As per coding guidelines, "Use important admonition for prerequisites, constraints, or high-impact information that materially affects correctness, supportability, compliance, or success".
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@source/administration-guide/manage/mmctl-command-line-tool.rst` around lines
5753 - 5755, Replace the `.. note::` admonition used for the command access
prerequisite with an `.. important::` admonition so the requirement ("This
command requires system admin privileges, or `local mode <#local-mode>`__.") is
elevated; locate the block containing that text (the markdown/admonition
starting with `.. note::` and change the directive token to `.. important::`,
preserving the indented content and link text exactly.
|
Newest code from mattermost has been published to preview environment for Git SHA 2d26145 |
Summary
Adds a reference entry for the new
mmctl roles listsubcommand introduced in mattermost/mattermost#34064 (milestone v11.7.0).Incorporates Novice Nate + Editor Evie fixes (linked local mode, note callout, parallel comments, "you can" lead-in) and the final evidence-safety cleanup: drops the child-specific
-h, --helpOptions block (not verified in PR evidence) and uses simplified Description wording.Resolves #8964.
Test plan
mmctl roles listanchor resolves.local modecross-reference resolves to the Local mode section on the same page.Generated with Claude Code