Reorganize the Documentation Table of Contents

[dwelsch-esi]

Reorganize the Table of Contents (TOC; the left-hand menu on the documentation page):

Among the benefits of this change are:

• Better welcome and orient new users
• Separate user roles (personas), if there are more than one
• Improve findability and access to tasks and procedures
• Separate conceptual, task, and reference information

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

Other issues describe reorganization to be done within the top-level sections of the TOC. For convenience, the issues are listed here.

• Reorganize Concepts #1363
• Write a Getting Started guide #1364
• Update the Operator Guide #1365
• Create a Reference Topic #1366

Specification

Here is a proposed high-level outline for the tech doc Table of Contents.

• KEDA Concepts. See Reorganize Concepts.
• Getting Started (New users start here!) (rename current "KEDA Documentation" heading). See Write a "Getting Started" Guide.
• Using KEDA or Operator Guide (rename current "Operate"). See Update the Operator Guide.
• Reference. See Create a Reference.
• Scalers.