Skip to content

Document mmctl roles list (v11.7.0)#8965

Open
Combs7th wants to merge 1 commit into
v11.7-documentationfrom
claude/issue-8964-20260512-2020
Open

Document mmctl roles list (v11.7.0)#8965
Combs7th wants to merge 1 commit into
v11.7-documentationfrom
claude/issue-8964-20260512-2020

Conversation

@Combs7th
Copy link
Copy Markdown
Contributor

Summary

Adds a reference entry for the new mmctl roles list subcommand 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, --help Options block (not verified in PR evidence) and uses simplified Description wording.

Resolves #8964.

Test plan

  • Verify the new subsection renders correctly in built HTML docs.
  • Verify the mmctl roles list anchor resolves.
  • Verify the local mode cross-reference resolves to the Local mode section on the same page.
  • SME review of permissions wording.

Generated with Claude Code

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>
@Combs7th Combs7th changed the base branch from master to v11.7-documentation May 12, 2026 20:50
@Combs7th Combs7th added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor labels May 12, 2026
@Combs7th Combs7th added this to the v11.7.0 milestone May 12, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds documentation for the mmctl roles list subcommand in the administration guide. The new section describes the command's purpose, version availability (Mattermost v11.7.0), access requirements, command syntax, and provides usage examples in both plain text and JSON output formats.

Changes

mmctl roles list command documentation

Layer / File(s) Summary
mmctl roles list command documentation
source/administration-guide/manage/mmctl-command-line-tool.rst
Added new mmctl roles list subsection under the mmctl roles command section, including functionality description, version introduction (v11.7.0), access requirements (system admin or local mode), command format, usage examples, and inherited parent command options.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and specifically describes the main change: documenting a new mmctl roles list subcommand for version 11.7.0.
Description check ✅ Passed The description is directly related to the changeset, explaining the new mmctl roles list subcommand documentation, editorial fixes applied, and test plan for validation.
Linked Issues check ✅ Passed The pull request adds documentation for the mmctl roles list subcommand as requested in issue #8964, including capability statement, access requirements, command format, and examples.
Out of Scope Changes check ✅ Passed All changes are directly related to documenting the new mmctl roles list subcommand; no unrelated or out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-8964-20260512-2020

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between d63b6e0 and 2d26145.

📒 Files selected for processing (1)
  • source/administration-guide/manage/mmctl-command-line-tool.rst

Comment on lines +5753 to +5755
.. note::

This command requires system admin privileges, or `local mode <#local-mode>`__.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 2d26145

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

mmctl: Add support for listing user roles through mmctl

1 participant