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.

Sign up for GitHub

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

Jump to bottom

[feature request] Better documentation on Operation HOWTO? #1588

Open

nashtsai opened this issue Apr 20, 2024 · 0 comments

Assignees

Labels

kind/feature-request

Contributor

nashtsai commented Apr 20, 2024

What would you like to be added:

On official https://openkruise.io/ doc. site, a section about operation how-to seems missing, i.e.,:

Prometheus metrics/telemetry, ref:
- https://docs.liqo.io/en/v0.10.2/usage/prometheus-metrics.html
- https://argo-cd.readthedocs.io/en/stable/operator-manual/metrics/
Troubleshooting guides (if any), ref:
- https://argo-cd.readthedocs.io/en/stable/operator-manual/troubleshooting/

Why is this needed:

It would be considered as an unprofessional act. where a stable release (1.x) of a software is released without proper operation manual.

Extra notes, check following guides:

nashtsai added the kind/feature-request label

nashtsai assigned FillZpp

furykerry assigned furykerry and unassigned FillZpp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment