Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make user roles explicit #1369

Open
Tracked by #221 ...
dwelsch-esi opened this issue Apr 15, 2024 · 0 comments
Open
Tracked by #221 ...

Make user roles explicit #1369

dwelsch-esi opened this issue Apr 15, 2024 · 0 comments

Comments

@dwelsch-esi
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant