Skip to content

Commit daa4457

Browse files
committed
Clean up docs: trim getting-started, fix sidebar, update README, remove pages
- Remove Common Issues and trim Next Steps in getting-started (keep only Configure Data Sources) - Fix sidebar label: "Managed Prometheus Alerts" -> "Send Alerts to Robusta" - Point GitHub Issue link to holmesgpt repo instead of robusta - Update README: mark as Robusta Classic, add HolmesGPT link at top - Remove Contributing page, docs-contributions, and Community Tutorials - Update conf.py redirects for removed pages https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS
1 parent 388770d commit daa4457

8 files changed

Lines changed: 15 additions & 136 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
<div id="top"></div>
22

33
<div align="center">
4-
<h1 align="center">Robusta - Better Prometheus Notifications for Kubernetes</h1>
5-
<h2 align="center">Better grouping, enrichment, and remediation of your existing alerts</h2>
4+
<h1 align="center">Robusta Classic - Prometheus Alert Enrichment for Kubernetes</h1>
5+
<h2 align="center">Rule-based grouping, enrichment, and remediation of your existing alerts</h2>
6+
<p align="center">
7+
<a href="https://github.com/robusta-dev/holmesgpt"><strong>Looking for HolmesGPT (AI-powered investigation)? Go here ↗</strong></a>
8+
</p>
69
<p align="center">
710
<a href="#%EF%B8%8F-how-it-works"><strong>How it Works</strong></a> |
811
<a href="#-installing-robusta"><strong>Installation</strong></a> |
@@ -12,6 +15,8 @@
1215
</p>
1316
</div>
1417

18+
> **Note:** This repository contains **Robusta Classic** — the rule-based alert enrichment engine. For AI-powered root cause analysis, see [HolmesGPT](https://github.com/robusta-dev/holmesgpt). Both can be installed together as part of the [Robusta platform](https://platform.robusta.dev/signup).
19+
1520
## What Can Robusta Do?
1621

1722
Compatible with kube-prometheus-stack, Prometheus Operator, and more.

docs/community-tutorials.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@
161161
"configuration/holmesgpt/toolsets/slab.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/slab/?tab=robusta-helm-chart",
162162
"coverage.html": "/master/how-it-works/coverage.html",
163163
"tutorials/python-profiling.html": "/master/playbook-reference/actions/python-troubleshooting.html#python-profiler",
164-
"tutorials/more-tutorials.html": "/master/community-tutorials.html",
164+
"tutorials/more-tutorials.html": "/master/help.html",
165165
"common-errors.html": "/master/help.html#common-errors",
166166
"user-guide/defining-playbooks.html": "/master/playbook-reference/defining-playbooks/index.html",
167167
"user-guide/global-config.html": "/master/setup-robusta/additional-settings.html#global-config",
@@ -201,10 +201,10 @@
201201
"developer-guide/actions/triggers-and-events.html": "/master/playbook-reference/actions/develop-actions/triggers-and-events.html",
202202
"developer-guide/actions/utility-functions.html": "/master/playbook-reference/actions/develop-actions/utility-functions.html",
203203
"developer-guide/actions/documenting-actions.html": "/master/playbook-reference/actions/develop-actions/documenting-actions.html",
204-
"developer-guide/platform/index.html": "/master/contributing.html",
205-
"developer-guide/platform/dev-setup.html": "/master/contributing.html",
206-
"developer-guide/platform/coding-conventions.html": "/master/contributing.html",
207-
"developer-guide/platform/docs-contributions.html": "/master/docs-contributions.html#improving-these-docs",
204+
"developer-guide/platform/index.html": "/master/help.html",
205+
"developer-guide/platform/dev-setup.html": "/master/help.html",
206+
"developer-guide/platform/coding-conventions.html": "/master/help.html",
207+
"developer-guide/platform/docs-contributions.html": "/master/help.html",
208208
"developer-guide/platform/sinks-guide.html": "/master/configuration/sinks/sinks-development.html",
209209
"user-guide/robusta-cli.html": "/master/setup-robusta/installation/index.html",
210210
"advanced/index.html": "/master/setup-robusta/installation/index.html",

docs/configuration/holmesgpt/getting-started.rst

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -64,27 +64,7 @@ If you store the Robusta UI token in a Kubernetes secret (instead of directly in
6464
name: my-robusta-secrets # Your existing secret
6565
key: ui-token # Your existing key
6666
67-
Common Issues
68-
-------------
69-
70-
**Not seeing the "Ask HolmesGPT" button?**
71-
- Ensure ``enableHolmesGPT: true`` is set
72-
- Check HolmesGPT pod is running: ``kubectl get pods -n robusta | grep holmes``
73-
- Verify AI provider credentials are correct
74-
75-
**Getting rate limit errors?**
76-
- Azure: Increase token limit in Azure Portal (minimum 450K)
77-
- OpenAI: Check your API quota and billing
78-
- Consider using Robusta AI for unlimited investigations
79-
80-
**Analysis seems incomplete?**
81-
- Enable additional data sources in `HolmesGPT data sources <https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart>`_
82-
- Ensure Prometheus is configured for metrics analysis
83-
- Check that pod logs are accessible
84-
8567
Next Steps
8668
----------
8769

88-
* :doc:`main-features` - See what HolmesGPT can do
89-
* `Configure Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart>`_ - Add more context for better analysis
90-
* `Helm Configuration Reference <https://holmesgpt.dev/reference/helm-configuration/?tab=robusta-helm-chart>`_ - Advanced HolmesGPT Helm settings
70+
* `Configure Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart>`_ - Add more context for better analysis

docs/contributing.rst

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/docs-contributions.rst

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/help.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Ask for help, or just say hi!
2222

2323
.. grid-item-card:: :octicon:`mark-github;1em;` Github Issue
2424
:class-card: sd-bg-light sd-bg-text-light
25-
:link: https://github.com/robusta-dev/robusta/issues
25+
:link: https://github.com/robusta-dev/holmesgpt/issues
2626

2727
--------------------------------
2828
Commercial Support

docs/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
:caption: Other Features
4747
:hidden:
4848

49-
Managed Prometheus Alerts <configuration/index>
49+
Send Alerts to Robusta <configuration/index>
5050
Track Config Changes <track-changes/kubernetes-changes>
5151
Connect Metrics <configuration/metric-providers>
5252
Notification Sinks <notification-routing/configuring-sinks>
@@ -60,8 +60,6 @@
6060
:hidden:
6161

6262
help
63-
contributing
64-
community-tutorials
6563

6664
Welcome to Robusta
6765
====================

0 commit comments

Comments
 (0)