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

Reorganize Concepts #1363

Open
Tracked by #221 ...
dwelsch-esi opened this issue Apr 12, 2024 · 1 comment
Open
Tracked by #221 ...

Reorganize Concepts #1363

dwelsch-esi opened this issue Apr 12, 2024 · 1 comment

Comments

@dwelsch-esi
Copy link

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.

@mhmohona
Copy link

mhmohona commented Jun 1, 2024

Hello! May I work on this issue?

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

2 participants