Document v11.8.0 membership policies, recommended channels, leave confirmation, and policy simulation#9036
Document v11.8.0 membership policies, recommended channels, leave confirmation, and policy simulation#9036Combs7th wants to merge 4 commits into
Conversation
…9029) * Remove CJK search feature flag mention now that it defaults to true * Clarify CJK search defaults to true on v11.9, flag-gated on v11.5-v11.8 * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…firmation, and policy simulation - Add public vs. private channel membership policy behavior, channel-level permission policies, and Simulate access to channel access rules docs - Add Simulate access steps to system-wide policies docs - Note membership policies, permission policies, and policy simulation in the ABAC configure-policies overview - Add Recommended Browse Channels filter note for end users - Distinguish public vs. private add-members behavior - Document the leave-confirmation modal (Leave channel / Mute instead) Resolves #9032 Co-authored-by: Combs7th <Combs7th@users.noreply.github.com>
|
Newest code from mattermost has been published to preview environment for Git SHA d6d3dd0 |
|
Heya @isacikgoz - I have a draft ready for us covering the membership policy/public channel advisory behavior, recommended channel surfaces, leave confirmation modal, channel-level file upload/download permission policies, and Simulate access updates. I tried to keep this minimal and focused on user/admin-visible behavior only. A few areas I’d especially appreciate review on:
If all is good, we'll get these merged in. Thanks! |
|
Newest code from mattermost has been published to preview environment for Git SHA 620c38c |
📝 WalkthroughWalkthroughThis PR documents Mattermost v11.8.0 membership policy features across admin and end-user guides, covering policy configuration and simulation, public-vs.-private channel behaviour differences, resource-level file permission policies, the Recommended filter, and leave confirmations for policy-added public channels. ChangesMembership Policies and Channel Access Control Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
🚥 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: 2
🤖 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/admin/abac-system-wide-policies.rst`:
- Around line 65-78: The lead-in still describes testing a rule against the
whole user base and counting granted users; update that opening paragraph (the
line that starts "Select **Test access rule** to test the rule against your user
base to return how many users would be granted access...") to instead describe
the "Simulate access" feature as a per-user, pre-save simulation that previews
allowed and denied outcomes for selected users in the policy editor of the
System Console; keep references to "Select Test access rule" and "Simulate
access" and briefly note it previews per-user allow/deny outcomes before saving
rather than returning a user count.
In `@source/end-user-guide/collaborate/join-leave-channels.rst`:
- Around line 112-120: Update the "Leave a public channel added by a membership
policy" paragraph: after the sentences that explain the difference between the
"Leave channel" and "Mute instead" choices, add a concise sentence stating that
choosing "Leave channel" may also remove the channel from Recommended while
choosing "Mute instead" keeps you in the channel (and preserves its Recommended
status); reference the existing phrases "Leave channel" and "Mute instead" so
the new sentence is placed with those explanations.
🪄 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: 47564942-0780-4d86-ac74-46b6e5a0a0fd
📒 Files selected for processing (6)
source/administration-guide/manage/admin/abac-channel-access-rules.rstsource/administration-guide/manage/admin/abac-system-wide-policies.rstsource/administration-guide/manage/admin/attribute-based-access-control.rstsource/end-user-guide/collaborate/browse-channels.rstsource/end-user-guide/collaborate/join-leave-channels.rstsource/end-user-guide/collaborate/manage-channel-members.rst
|
@wiersgallak - This one will need editor review as well after dev review is complete. |
| - :doc:`Attribute-Based Access Control (ABAC) </administration-guide/manage/admin/attribute-based-access-control>` must be enabled by a System Admin in **System Console > System Attributes > Attribute-Based Access**. | ||
| - You need Channel Admin permissions and the ``manage_channel_access_rules`` permission. | ||
| - Channel access rules are available only for private channels. | ||
| - Self-service channel access rules in the **Access Control** tab in Channel Settings are configured for private channels. Membership policies apply to both public and private channels, with different behavior by channel type. See :ref:`Public and private channel behavior <administration-guide/manage/admin/abac-channel-access-rules:public and private channel behavior>`. |
There was a problem hiding this comment.
@Combs7th This sentence is really clunky. Can you please give it another review?
There was a problem hiding this comment.
Good callout here! I agree.
There was a problem hiding this comment.
@claude - Please analyze the sentence above through the lense of Editor Evie, and commit the best possible alternative version that's more clear, concise, and less clunky.
There was a problem hiding this comment.
Claude finished @Combs7th's task in 1m 9s —— View job
Editor Evie review — line 23 rewrite
- Read the target sentence and surrounding context
- Load the Editor Evie persona
- Rewrite the sentence for clarity/concision
- Commit and push (
56a7ce9)
What was clunky
Self-service channel access rules in the Access Control tab in Channel Settings
are configured forprivate channels.
Through Evie's lens, the original had three issues:
- Stacked prepositions — "in the … tab in Channel Settings" repeats in back-to-back, which reads awkwardly.
- Vague passive verb — "are configured for private channels" buries the actual point. The rules don't get configured for private channels; they simply apply only to them. Readers couldn't tell whether this was a restriction or just a typical use case.
- Redundant noun — "channel access rules … in Channel Settings" repeats channel.
Committed rewrite
Self-service access rules in the Access Control tab of Channel Settings apply only to private channels. Membership policies apply to both public and private channels, with behavior that varies by channel type. See :ref:
Public and private channel behavior.
Changes: dropped the redundant channel, swapped the second in for of, and replaced the passive "are configured for" with the crisp, accurate "apply only to" — which makes the public/private distinction in the next sentence land cleanly. Also tightened "with different behavior by channel type" → "with behavior that varies by channel type." The :ref: link is unchanged.
There was a problem hiding this comment.
@amyblais @wiersgallak - Do you think that wording clean-up above will suffice?
We will still need a dev review from @isacikgoz as well whenever able.
Co-authored-by: Combs7th <Combs7th@users.noreply.github.com>
|
Newest code from mattermost has been published to preview environment for Git SHA 56a7ce9 |
Updates the ABAC / membership policy docs for Mattermost v11.8.0:
Resolves #9032
Generated with Claude Code