Skip to content

Make user roles explicit #1369

@dwelsch-esi

Description

@dwelsch-esi

In the introduction or new user documentation, explicitly state the intended user roles (personas) for KEDA. There might only be one role (Operator).

A second implicit user role always exists (project Contributor); be careful to keep Contributor documentation separate from the Operator documentation.

If there is more than one user role (ignoring Contributor), write procedures for each persona into separate Guide documents.

Use-Case

The distinction between user roles is based on what the user needs to do with the product. KEDA seems to have only one explicit user role (or persona), an Operator using KEDA to scale resources on a Kubernetes installation. Regardless, this user role should be explicitly distinguished from the project Contributor user role. Use cases are different between the two roles.

Specification

The definition of the Operator role could be as minimal as a "who should use this documentation" paragraph in the product introduction.

One strategy for separating the documentation is to confine the Contributor docs to the GitHub repo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    cant-touch-thisAll issues that should not be automatically closed by our stale bot

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions