docs: document workspace and group roles (access control)#116
Open
ben-miru wants to merge 4 commits into
Open
Conversation
Document the workspace and group role model. Add the access control page covering tiers, workspace roles (viewer/operator/provisioner/ publisher), and group roles (viewer/operator/provisioner/manager), swap it into the Users nav, and remove the superseded roles page.
Add the MemberBadge component used by the access control page and repoint the role badge/link targets from the removed /admin/users/roles path to /admin/users/access-control.
Use 'user types' instead of 'tiers' to match the backend UserType model (owner/admin/member), including the section heading, table header, and the cross-reference anchor.
Replace the group-role badge list and permissions matrix with per-role subsections (viewer/operator/provisioner/manager), each with a prose description and linked operation lists, matching the workspace roles format. Also fix a double dash and a typo in the administrative privileges intro.
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
1 participant
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.
What
Finishes the access control documentation page (
docs/admin/users/access-control.mdx), filling in the previously-empty Workspace roles and Group roles sections, and wires the new page into the docs.Why
The page existed only as a stub: it documented the owner/admin/member tiers but left the role model undocumented. This completes the migration from the old single
Rolespage to a layered tiers + roles model.Changes
viewer/operator/provisioner/publisher) and group roles (viewer/operator/provisioner/manager), each with a per-role summary and a permissions matrix.Memberstier section with the role model (a member's application access now comes from roles, not blanket access).rolespage toaccess-control, and delete the supersededroles.mdx.MemberBadgecomponent and repoint role badge/link targets from the removed/admin/users/rolespath to/admin/users/access-control.Model — grounded in the backend
The role descriptions and matrices were derived from the backend's current implementation (
internal/authz/permissions/configs/role_grants.go,internal/authz/user/grants.go, and the role enums), not just the design doc:operator/provisioner/publisheradding write access on top. Roles are additive.manager(matching the backend enum and theGroupManagerBadge), not the design doc's "admin".Validation
Targeted docs lint on the changed files — MDX prose lint, ESLint (MDX), and CSpell — all pass.
Out of scope
The broader rollout of the new role badges onto action headings across
learn/pages (groups, devices, releases, schemas, config-types) is left as separate follow-up work and is not included here.🤖 Generated with Claude Code