[feature request] Better documentation on Operation HOWTO?

[nashtsai]

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:

• https://sdk.operatorframework.io/docs/best-practices/observability-best-practices/
• https://sdk.operatorframework.io/docs/building-operators/golang/advanced-topics/#monitoring-and-observability

[stale[bot]]

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