Skip to content

Add RBAC-specific documentation and improve discoverability #18393

Open
@blink-so

Description

@blink-so

Problem

Our documentation doesn't properly mention or define RBAC (Role-Based Access Control), which is a key Premium feature for tying templates to groups. When users search our docs for "RBAC", nothing comes up, making this important feature difficult to discover.

Requested Changes

Add comprehensive RBAC-specific documentation that includes:

Core Documentation Tasks

  • Explicitly mention and define RBAC and how it fits with other Coder features
  • Explain how RBAC interacts or overlaps with IdP sync (or clarify when it doesn't)
  • Document how to implement template access controls using RBAC
  • Add RBAC terminology and keywords for improved searchability

Content Assessment

Current Documentation Review:

  • admin/users/groups-roles: Contains relevant functionality but lacks explicit RBAC terminology and definition
  • admin/users/idp-sync: Has some RBAC mentions but could be clearer about the relationship

Content Deficits:

  • Missing explicit RBAC definition and conceptual overview
  • Lack of searchable RBAC terminology throughout relevant docs
  • Unclear relationship between RBAC, groups, roles, and IdP sync
  • No dedicated section explaining template access control implementation

Findability Issues:

  • RBAC acronym not used consistently in headings or content
  • Missing keywords that users would search for
  • No cross-references between related RBAC concepts

Acceptance Criteria

  • Users searching for "RBAC" can find relevant documentation
  • Clear definition of RBAC in Coder context
  • Documented relationship between RBAC and IdP features
  • Step-by-step guide for implementing template access controls
  • Improved keyword coverage for discoverability

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsArea: coder.com/docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions