Description
Remove everything that's not a conceptual overview. Separate task and reference information and move them to the Operator Guide and the Reference section respectively.
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
The conceptual overview (also variously called a technical overview or architectural overview depending on the product) describes how the product works at a high level. It does not go into detail (for example, it might use pseudo-code; providing syntax is not the point here); rather, it tries to help the user build a mental model of the product's architecture and subsystems so that tasks and reference information will "make sense" and "stick" when the reader goes on to use the product.
Specification
Here is a proposed outline. Links are to existing pages that can be used as-is or provide a starting point.
- KEDA Concepts
- What is KEDA?
- How KEDA works
- KEDA Architecture
- KEDA Custom Resources (CRDs)
- Scaling Deployments, StatefulSets and Custom Resources
- Overview
- Scaling Deployments and Stateful Sets
- Scaling Custom Resources
- Scaling Jobs
- Authentication
- External Scalers
- Admission Webhooks
Metadata
Metadata
Assignees
Labels
Type
Projects
Status