You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Revise the Operator Guide to be user focused: it should provide explicit instructions to complete any task the user might commonly need to accomplish after the product is deployed.
KEDA has one user persona, a Kubernetes Operator whose goal is to:
Add KEDA to a Kubernetes cluster
Use KEDA to scale resource usage on the cluster
The Operator Guide gives the user detailed instructions on how to do the second part. It should be predominantly a set of step-by-step instructions for any task the Operator must accomplish to use and maintain KEDA in the cluster.
Some guidelines for improving the KEDA Operator Guide:
Can be named "Using KEDA" or "Operator Guide".
Base the guide on the existing "Operator" section.
Move "Troubleshooting" to the end of the Operator Guide.
Relocate sections that are purely reference information, including these sections in Cluster:
Break up long pages containing several topics. Aim for one major topic per page. For example, all HTTP-related headings on the Cluster page could go on one page named "Using HTTP".
Specification
Here is a proposed outline. Links are to existing pages that can be used as-is or provide a starting point.
Revise the Operator Guide to be user focused: it should provide explicit instructions to complete any task the user might commonly need to accomplish after the product is deployed.
This issue tracks recommended changes resulting from an analysis of the KEDA documentation commissioned by CNCF. The analysis and supporting documents are here: https://github.com/cncf/techdocs/tree/main/assessments/0011-keda/
Use-Case
KEDA has one user persona, a Kubernetes Operator whose goal is to:
The Operator Guide gives the user detailed instructions on how to do the second part. It should be predominantly a set of step-by-step instructions for any task the Operator must accomplish to use and maintain KEDA in the cluster.
Some guidelines for improving the KEDA Operator Guide:
Specification
Here is a proposed outline. Links are to existing pages that can be used as-is or provide a starting point.
Setting Timeouts
Disabling Keep-alive
Using HTTP Proxies
[Configuring Minimum TLS Version]
The text was updated successfully, but these errors were encountered: