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
Create a top-level table of contents (TOC) heading and reorganize the documentation so that this section contains all reference pages.
Elsewhere in the documentation where the user needs reference information (for example, to choose a specific configuration value or to check the syntax of a command), link to the appropriate reference page.
- Moved some content from KEDA concept topics to Reference.
- Added a glossary, issue kedacore#1367
- Removed non-inclusive language, issue kedacore#1373kedacore#1366kedacore#1367kedacore#1373
Umbrella issue for CNCF tech docs recommendations:
kedacore#1361
Signed-off-by: David Welsch <dwelsch@expertsupport.com>
- Moved some content from KEDA concept topics to Reference.
- Added a glossary, issue kedacore#1367
- Removed non-inclusive language, issue kedacore#1373kedacore#1366kedacore#1367kedacore#1373
Umbrella issue for CNCF tech docs recommendations:
kedacore#1361
Signed-off-by: David Welsch <dwelsch@expertsupport.com>
Create a top-level table of contents (TOC) heading and reorganize the documentation so that this section contains all reference pages.
Elsewhere in the documentation where the user needs reference information (for example, to choose a specific configuration value or to check the syntax of a command), link to the appropriate reference page.
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
Some typical types of reference pages include:
Specifically for KEDA:
Specification
Here is a proposed outline. Links are to existing pages that can be used as-is or provide a starting point.
The text was updated successfully, but these errors were encountered: