docs: improve metrics and health probes docs by csviri · Pull Request #3333 · operator-framework/java-operator-sdk
Pull request overview
Updates the operations documentation to better separate health-probe guidance from metrics guidance, and to improve the structure and discoverability of metrics-related topics.
Changes:
- Removes the
RuntimeInfoliveness/readiness probe discussion from the metrics page and consolidates probe-related references in the health probes page. - Promotes the Grafana dashboard and end-to-end metrics exploration sections to higher-level headings.
- Moves the “Aggregated Metrics” section earlier in the metrics page to make multi-provider setups easier to find.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/content/en/docs/documentation/operations/metrics.md | Reorganizes metrics documentation structure, promotes dashboard/E2E sections, and relocates “Aggregated Metrics” content. |
| docs/content/en/docs/documentation/operations/health-probes.md | Adds a cross-reference to ConfigurationService.stopOnInformerErrorDuringStartup from the RuntimeInfo-based probe guidance. |