Skip to content

docs: enhance MetricsAvailable condition documentation#568

Closed
github-actions[bot] wants to merge 1 commit intomainfrom
docs/update-metrics-condition-docs-02c36f6c56a28882
Closed

docs: enhance MetricsAvailable condition documentation#568
github-actions[bot] wants to merge 1 commit intomainfrom
docs/update-metrics-condition-docs-02c36f6c56a28882

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Jan 9, 2026

Summary

This PR enhances documentation for the MetricsAvailable status condition feature introduced in PR #567. While the core feature is already well-documented, this PR fills minor gaps to improve discoverability and usability.

Changes Made

1. CHANGELOG Enhancement

2. CRD Reference Enhancement

  • Added "Status Conditions" section with detailed documentation
  • Documented both MetricsAvailable and OptimizationReady condition types
  • Included examples of condition YAML output
  • Added kubectl commands for viewing conditions
  • Cross-referenced comprehensive metrics health monitoring guide

3. Main README Enhancement

  • Added "Operations & Monitoring" section in documentation links
  • Highlighted Metrics Health Monitoring guide for operators
  • Improved discoverability of monitoring and troubleshooting resources

Documentation Coverage

The feature is now comprehensively documented across:

  • ✅ CHANGELOG - Bug fix entry with implementation details
  • ✅ CRD Reference - Condition types, reasons, and examples
  • ✅ Main README - Quick access to monitoring documentation
  • ✅ Metrics Health Monitoring guide - Comprehensive troubleshooting (existing)
  • ✅ API Types - Well-commented condition constants (existing)

Testing

  • Documentation follows Diátaxis framework principles
  • Code examples are accurate and tested
  • Cross-references are valid
  • Markdown formatting is correct
  • Links are functional

Related Issues/PRs


Documentation Quality: This update ensures operators can easily discover and understand the MetricsAvailable condition feature for troubleshooting metrics collection issues.

AI generated by Update Docs

- Add MetricsAvailable condition fix to CHANGELOG v0.5.0
- Enhance CRD reference with detailed condition documentation
- Add Operations & Monitoring section to main README
- Include examples of condition usage and kubectl commands
- Link to comprehensive metrics health monitoring guide

This update ensures the MetricsAvailable condition feature (PR #567)
is properly documented across all relevant guides.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant