Write a Getting Started guide

[dwelsch-esi]

Write a task-based, step-by-step workflow for new users. Start with the current KEDA Documentation section.

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

Assume the new user has no experience with KEDA and is fairly new to Kubernetes. The current documentation assumes that users know how to deploy and use Kubernetes Custom Resources, and that using KEDA is a matter of knowing the right configuration parameters and deploying the right resources. This might be true for veteran users, but new users want explicit, foolproof instructions.

Specification

The following outline has been annotated to emphasize the purpose of each section. Links are to existing pages that can be used as-is or provide a starting point. Pages with multiple procedures (for example, the "Deploying KEDA" page) should be split into multiple pages, one for each procedure.

• Getting Started (New users start here!) (rename current "KEDA Documentation" heading) Make the new user entry point obvious.
  • Deploying KEDA This is analagous to "Install" for application software or a plugin. It's the starting point for a new user.
    • Overview Briefly explain the differences between installation methods. What is the advantage of one deployment method over another? If the choice is not completely arbitrary, explain the differences here to help the new user decide.
    • Prerequisites Make sure the new user has their tools gathered up before they start. This reduces frustration. Also, if prerequisites depend on the deployment type, you can optionally put a Prerequisites section in each deployment procedure rather than here.
    • Deploying with Helm
      • Installing
      • Uninstalling
    • Deploying with Operator Hub
      • Installing
      • Uninstalling
    • Deploying using the deployment YAML files
      • Installing
      • Uninstalling
    • Deploying KEDA on MicroK8s
      • Installing
      • Uninstalling
  • Hello, KEDA (write a procedure for a simplest-possible use case for users to get started on - something like https://github.com/kedacore/sample-hello-world-azure-functions) Analagous to a "Hello World" exercise in programming language or API guides

[mhmohona]

Hello! May I work on this issue?

[tomkerkhove]

Certainly!

[shubhusion]

@tomkerkhove I would like to work on this issue. But can you provide the directory where files needs to be added.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

[shubhusion]

is this issue still relevant ?

[mhmohona]

Hey @shubhusion, I am working on it, submitted PR.

Please find other issues from here to work on.

[shubhusion]

Hey @shubhusion, I am working on it, submitted PR.

Please find other issues from here to work on.

Great, thanks for letting me know!

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically closed due to inactivity.

[nate-double-u]

I'm not sure this has been completed, if it was just the bot that closed this could we reopen it?