-
Notifications
You must be signed in to change notification settings - Fork 426
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
Comments
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. |
I think it's best not to auto-delete this issue, I think it is still relevant. |
@nate-double-u I would like to work on this issue if assigned. |
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 |
I will start working on this issue after my PR #1415 on Procedure to Setup a Scaler is merged. |
I am working on this issue now |
@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? |
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:
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.
Setting Timeouts
Disabling Keep-alive
Using HTTP Proxies
[Configuring Minimum TLS Version]
The text was updated successfully, but these errors were encountered: