Skip to content

Document the Ranked attribute type#9086

Open
davidkrauser wants to merge 1 commit into
v11.9-documentationfrom
dk-ranked-attribute-docs
Open

Document the Ranked attribute type#9086
davidkrauser wants to merge 1 commit into
v11.9-documentationfrom
dk-ranked-attribute-docs

Conversation

@davidkrauser

Copy link
Copy Markdown

Add a Ranked entry to the user-attribute type list, document its ordered comparison operators in the system-wide access policy match options, and note that classification markings use the same Ranked attribute type.

Add a Ranked entry to the user-attribute type list, document its ordered
comparison operators in the system-wide access policy match options, and
note that classification markings use the same Ranked attribute type.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@davidkrauser davidkrauser requested a review from Combs7th July 6, 2026 19:15
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates Mattermost documentation to describe a new Ranked user attribute type. Changes clarify that classification markings use Ranked attributes for ordering, and document supported ordered comparison operators for Ranked attributes in ABAC Simple Mode policy configuration.

Changes

Ranked Attribute Documentation

Layer / File(s) Summary
Ranked attribute type definition
source/administration-guide/manage/admin/user-attributes.rst
Adds the Ranked attribute type to the supported types list, describing ordered-value behaviour and threshold-based comparisons.
ABAC Simple Mode comparison options
source/administration-guide/manage/admin/abac-system-wide-policies.rst
Documents ordered comparison match options for Ranked attributes (exact/not, at least/greater than, at most/less than) in Simple Mode policy configuration.
Classification markings ordering
source/administration-guide/configure/site-configuration-settings.rst
Clarifies that classification level ordering uses the Ranked attribute type, aligning with user attribute behaviour.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Related Issues: None specified

Related PRs: None specified

Suggested labels: documentation

Suggested reviewers: None specified

Poem
A rabbit hops through docs anew,
Ranking levels, low to high, in view.
Thresholds set where matches lie,
Classification ranks reach for the sky.
Three files touched, one concept true. 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main documentation change: introducing the Ranked attribute type.
Description check ✅ Passed The description matches the documented changes to user attributes, policy match options, and classification markings.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dk-ranked-attribute-docs

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

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

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

@Combs7th Combs7th added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor labels Jul 8, 2026
@Combs7th Combs7th added this to the v11.9.0 milestone Jul 8, 2026
@amyblais amyblais changed the base branch from master to v11.9-documentation July 8, 2026 06:09
@davidkrauser

Copy link
Copy Markdown
Author

@amyblais quick question about the workflow for documentation changes: if this goes directly into the v11.9 branch, how will it get into master for future releases? Do I need to open another PR for that?

@davidkrauser davidkrauser requested a review from pvev July 8, 2026 15:42
@amyblais amyblais removed the 2: Editor Review Requires review by an editor label Jul 8, 2026
@amyblais

amyblais commented Jul 8, 2026

Copy link
Copy Markdown
Member

quick question about the workflow for documentation changes: if this goes directly into the v11.9 branch, how will it get into master for future releases? Do I need to open another PR for that?

@davidkrauser I will merge the v11.9 branch into the master branch via this PR #9043 on the release day.

@esethna

esethna commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

@pvev friendly ping on review here, thanks!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants