docs: clarify health check docs and sync operator intro#1837
Conversation
Adds a new section showing how to deploy a HealthCheck alongside your application to verify the impact of a new deploy. Covers including health checks in deployment manifests, polling results in CI/CD, and tips for versioning, timeouts, labels, and ArgoCD integration. https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
…ywhere - Create dedicated docs/operator/deployment-verification.md with one-time and scheduled health check patterns for deploy verification - Remove inline section from health-checks.md (now on its own page) - Add to operator .nav.yml (listed second, after overview) - Link prominently from operator index.md (features + next steps) - Link from main docs index.md (new "Running in Kubernetes?" section) - Link from README.md (new bullet points under feature list) https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
Change the ScheduledHealthCheck example from every-15-minutes to once per day, and add a tip admonition warning about cost implications of increasing frequency. https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
- Rewrite docs index section from "Running in Kubernetes?" to "Run HolmesGPT 24/7" — aligns with KubeCon keynote messaging - Update README operator bullet to emphasize background monitoring - Rewrite operator index intro paragraph to match keynote framing - Clarify that versioned check names apply to one-time HealthChecks only, not ScheduledHealthChecks https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
Mention that a complex check could cost $1+ with state-of-the-art models like Claude Opus, so users understand the cost implications before increasing schedule frequency. https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
…stack notes - Move operator section to top of README with "New:" callout - Add GitHub MCP recommendation so Holmes can open PRs to fix problems - Clarify that operator checks query any connected data source, not just Kubernetes (VMs, cloud services, databases, SaaS platforms) - Add "Not just Kubernetes" bullet to features in operator index, docs index, and README https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
… cost warning - Remove duplicated ScheduledHealthCheck YAML from deployment-verification page, replace with a "You Can Also" cross-link to the dedicated page - Add cost-per-call warning and frequency table to scheduled-health-checks page so cost info lives in one canonical place https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
- Remove "You Can Also:" prefix from deployment-verification heading - Sync README operator section with the operator index intro (adds "Most AI agents" framing and multi-stack paragraph) https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review.
Tip: disable this comment in your organization's Code Review settings.
✅ Deploy Preview for holmes-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…th-check-docs-EG3vx
https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW Signed-off-by: Claude <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThe documentation homepage ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Summary by CodeRabbit