Document v11.8.0 membership policies, recommended channels, leave confirmation, and policy simulation#9036
Open
Combs7th wants to merge 3 commits into
Open
Document v11.8.0 membership policies, recommended channels, leave confirmation, and policy simulation#9036Combs7th wants to merge 3 commits into
Combs7th wants to merge 3 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>
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA d6d3dd0 |
Combs7th
added
1: Dev Review
Contributor
Author
|
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! |
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA 620c38c |
Contributor
📝 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
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
Comment on lines
+65
to
+78
| Simulate access | ||
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| Select **Test access rule** to test the rule against your user base to return how many users would be granted access to the channel based on the current rule. Test your rules to ensure the intended scope and avoid unexpected access changes. | ||
|
|
||
| From Mattermost v11.8.0, you can use **Simulate access** to preview allowed and denied outcomes for specific users before saving policy changes: | ||
|
|
||
| 1. Open the policy editor in the System Console. | ||
| 2. Select **Simulate access**. | ||
| 3. Choose the users you want to test. | ||
| 4. Review the allowed and denied outcomes by action, such as joining a channel or uploading and downloading files. | ||
| 5. Adjust the rules before saving. | ||
|
|
||
| Simulation can test draft policy changes before they affect live channel access or file permissions. Detailed rule and attribute information is shown only when the denial comes from the policy or scope you're editing; otherwise, Mattermost may show that access was denied by another policy. |
Contributor
There was a problem hiding this comment.
Rewrite the lead-in to match Simulate access.
The opening sentence still talks about testing against the whole user base and counting granted users, which no longer matches the per-user pre-save simulation described below. Readers will get two different mental models for the same feature.
🤖 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/admin/abac-system-wide-policies.rst`
around lines 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.
Comment on lines
+112
to
+120
| Leave a public channel added by a membership policy | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| From Mattermost v11.8.0, when you leave a public channel you were added to by a membership policy, Mattermost asks you to confirm: | ||
|
|
||
| - Choosing **Leave channel** removes you from the channel. | ||
| - Choosing **Mute instead** keeps you in the channel and mutes its notifications. | ||
|
|
||
| If the channel is already muted, Mattermost shows **Cancel** and **Leave channel** instead of **Mute instead**. No newline at end of file |
Contributor
There was a problem hiding this comment.
Mention the recommendation side-effect.
The leave-confirmation text explains Leave channel vs Mute instead, but it doesn't tell users that leaving can also remove the channel from Recommended. That missing context is why the mute option exists for policy-added public channels.
✏️ Suggested addition
From Mattermost v11.8.0, when you leave a public channel you were added to by a membership policy, Mattermost asks you to confirm:
- Choosing **Leave channel** removes you from the channel.
- Choosing **Mute instead** keeps you in the channel and mutes its notifications.
+- Leaving may also remove the channel from **Recommended** results tied to the policy.Based on the PR objective, this flow should also tell users that leaving may remove the channel from Recommended.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Leave a public channel added by a membership policy | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| From Mattermost v11.8.0, when you leave a public channel you were added to by a membership policy, Mattermost asks you to confirm: | |
| - Choosing **Leave channel** removes you from the channel. | |
| - Choosing **Mute instead** keeps you in the channel and mutes its notifications. | |
| If the channel is already muted, Mattermost shows **Cancel** and **Leave channel** instead of **Mute instead**. | |
| Leave a public channel added by a membership policy | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| From Mattermost v11.8.0, when you leave a public channel you were added to by a membership policy, Mattermost asks you to confirm: | |
| - Choosing **Leave channel** removes you from the channel. | |
| - Choosing **Mute instead** keeps you in the channel and mutes its notifications. | |
| - Leaving may also remove the channel from **Recommended** results tied to the policy. | |
| If the channel is already muted, Mattermost shows **Cancel** and **Leave channel** instead of **Mute instead**. |
🤖 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/end-user-guide/collaborate/join-leave-channels.rst` around lines 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.
Contributor
Author
|
@wiersgallak - This one will need editor review as well after dev review is complete. |
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
2 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.
Updates the ABAC / membership policy docs for Mattermost v11.8.0:
Resolves #9032
Generated with Claude Code