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

Update the Operator Guide #1365

Open
Tracked by #1361 ...
dwelsch-esi opened this issue Apr 12, 2024 · 10 comments · May be fixed by #1456
Open
Tracked by #1361 ...

Update the Operator Guide #1365

dwelsch-esi opened this issue Apr 12, 2024 · 10 comments · May be fixed by #1456
Assignees

Comments

@dwelsch-esi
Copy link
Contributor

Revise the Operator Guide to be user focused: it should provide explicit instructions to complete any task the user might commonly need to accomplish after the product is deployed.

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

KEDA has one user persona, a Kubernetes Operator whose goal is to:

  1. Add KEDA to a Kubernetes cluster
  2. Use KEDA to scale resource usage on the cluster

The Operator Guide gives the user detailed instructions on how to do the second part. It should be predominantly a set of step-by-step instructions for any task the Operator must accomplish to use and maintain KEDA in the cluster.

Some guidelines for improving the KEDA Operator Guide:

Specification

Here is a proposed outline. Links are to existing pages that can be used as-is or provide a starting point.

Copy link

stale bot commented Jun 12, 2024

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 stale bot added the stale All issues that are marked as stale due to inactivity label Jun 12, 2024
@nate-double-u
Copy link
Contributor

I think it's best not to auto-delete this issue, I think it is still relevant.

@shubhusion
Copy link
Contributor

shubhusion commented Jun 14, 2024

@nate-double-u I would like to work on this issue if assigned.

@stale stale bot removed the stale All issues that are marked as stale due to inactivity label Jun 14, 2024
@nate-double-u
Copy link
Contributor

I'm not able to assign folks to issues in this repo. Though, I'm sure PRs are welcome! You can take a look at Keda's getting started info here: https://keda.sh/community/#get-involved

@shubhusion
Copy link
Contributor

shubhusion commented Jun 28, 2024

I will start working on this issue after my PR #1415 on Procedure to Setup a Scaler is merged.

@shubhusion
Copy link
Contributor

I am working on this issue now

@shubhusion
Copy link
Contributor

@JorTurFer @tomkerkhove I wanted to confirm if I can proceed with the outlined plan for updating the Operator Guide. Based on the current documentation, setting up a scaler and troubleshooting are already included in the Getting Started section.

Additionally, should I create separate pages for Usage Scenarios or just link to the existing GitHub repository?

@shubhusion shubhusion linked a pull request Aug 18, 2024 that will close this issue
1 task
Copy link

stale bot commented Oct 17, 2024

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 stale bot added the stale All issues that are marked as stale due to inactivity label Oct 17, 2024
Copy link

stale bot commented Oct 29, 2024

This issue has been automatically closed due to inactivity.

@nate-double-u
Copy link
Contributor

I think it's best not to auto-delete this issue, I think it is still relevant.

@JorTurFer JorTurFer reopened this Oct 30, 2024
@stale stale bot removed the stale All issues that are marked as stale due to inactivity label Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants