Skip to content

Commit 48aa608

Browse files
committed
docs: hide outdated CLI install paths, reframe as Robusta Classic
The robusta CLI install flow (robusta gen-config / pipx / docker) is outdated. Drop those paths from the install docs in favor of the SaaS signup wizard, and reframe non-Holmes/non-SaaS content as Robusta Classic so the primary docs focus on the AI agent + Robusta Platform (with HolmesGPT OSS docs living separately at holmesgpt.dev). - Rename "Other Features" toctree caption to "Robusta Classic" - Consolidate install pages into a single Install Robusta page (drop the all-in-one Prometheus and Build-from-Source variants; Holmes users always have an existing observability stack) - Strip robusta gen-config / robusta-cli references from the Slack sink, multi-cluster, and help/troubleshooting pages - Update conf.py redirects for removed pages https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f
1 parent 3be09d7 commit 48aa608

12 files changed

Lines changed: 48 additions & 431 deletions

docs/conf.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,10 @@
7171
"developer-guide/actions/findings-api.html": "/master/playbook-reference/actions/develop-actions/findings-api.html",
7272
"tutorials/my-first-custom-action.html": "/master/playbook-reference/actions/develop-actions/index.html",
7373
"user-guide/self-hosting.html": "/master/how-it-works/oss-vs-saas.html",
74-
"getting-started/installation.html": "/master/setup-robusta/installation/all-in-one-installation.html",
74+
"getting-started/installation.html": "/master/setup-robusta/installation/index.html",
75+
"setup-robusta/installation/all-in-one-installation.html": "/master/setup-robusta/installation/index.html",
76+
"setup-robusta/installation/standalone-installation.html": "/master/setup-robusta/installation/index.html",
77+
"setup-robusta/installation/dev-setup.html": "/master/help.html",
7578
"tutorials/java-troubleshooting.html": "/master/tutorials/application-troubleshooting-java.html",
7679
"catalog/sinks/index.html": "/master/configuration/sinks/index.html",
7780
"tutorials/prometheus-enrichment.html": "/master/tutorials/alert-custom-enrichment.html",
@@ -216,7 +219,7 @@
216219
"playbook-reference/overview.html": "/master/playbook-reference/index.html",
217220
"playbook-reference/defining-playbooks/playbook-basics.html": "/master/playbook-reference/index.html",
218221
"how-it-works/alert-builtin-enrichment.html": "/master/playbook-reference/builtin-alert-enrichment.html",
219-
"setup-robusta/installation/extend-prometheus-installation.html": "/master/setup-robusta/installation/standalone-installation.html",
222+
"setup-robusta/installation/extend-prometheus-installation.html": "/master/setup-robusta/installation/index.html",
220223
"playbook-reference/defining-playbooks/index.html": "/master/playbook-reference/index.html",
221224
"configuration/alertmanager-integration/alert-custom-prometheus.html": "/master/configuration/alertmanager-integration/embedded-prometheus.html#creating-custom-prometheus-alerts",
222225
"configuration/alertmanager-integration/index.html": "/master/configuration/index.html",

docs/configuration/sinks/sinks-development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Each sink consists of a sink class and a config class. Optionally, helpers are u
2727

2828
To implement a new sink you must:
2929

30-
1. :ref:`Build Robusta from source <Build from Source>`
30+
1. Clone the `Robusta repo <https://github.com/robusta-dev/robusta>`_ and follow the README to build from source
3131
2. Add a new Python module inside `src/robusta/core/sinks <https://github.com/robusta-dev/robusta/tree/master/src/robusta/core/sinks>`_ containing your sink’s source code
3232
3. Implement a sink config class
3333
4. Implement a sink class

docs/configuration/sinks/slack.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Quick Start
2020

2121
**Option 1: Automatic Setup (Recommended)**
2222

23-
When installing Robusta, run ``robusta gen-config`` and follow the prompts. This automatically configures Slack using our `official
23+
Sign up for a `free Robusta account <https://platform.robusta.dev/signup>`_ and connect Slack during the signup wizard. This automatically configures Slack using our `official
2424
Slack app <https://slack.com/apps/A0214S5PHB4-robusta?tab=more_info>`_.
2525

2626
Note: Robusta can only write messages and doesn't require read permissions.
2727

2828
**Option 2: Manual Configuration**
2929

30-
Generate a Slack API key by running ``robusta integrations slack``, then add to your ``generated_values.yaml``:
30+
Generate a Slack API key on your own, then add it to your ``generated_values.yaml``:
3131

3232
.. code-block:: yaml
3333

docs/help.rst

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -41,54 +41,12 @@ Issues are organized by installation phase to help you quickly find solutions.
4141

4242
<div style="margin: 20px 0; padding: 15px; background-color: #f0f7ff; border-left: 4px solid #0066cc;">
4343
<strong>Where are you stuck?</strong><br>
44-
• <a href="#phase-1-configuration-generation">Phase 1: Configuration Generation</a> - Issues with robusta gen-config<br>
45-
• <a href="#phase-2-helm-installation">Phase 2: Helm Installation</a> - Helm install/upgrade failures<br>
46-
• <a href="#phase-3-runtime-issues">Phase 3: Runtime Issues</a> - Alerts not arriving, pods crashing<br>
47-
• <a href="#phase-4-integration-issues">Phase 4: Integration Issues</a> - Slack, Prometheus connection problems
44+
• <a href="#phase-1-helm-installation">Phase 1: Helm Installation</a> - Helm install/upgrade failures<br>
45+
• <a href="#phase-2-runtime-issues">Phase 2: Runtime Issues</a> - Alerts not arriving, pods crashing<br>
46+
• <a href="#phase-3-integration-issues">Phase 3: Integration Issues</a> - Slack, Prometheus connection problems
4847
</div>
4948

50-
Phase 1: Configuration Generation
51-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52-
53-
Issues when running ``robusta gen-config`` or generating initial configuration.
54-
55-
.. details:: command not found: robusta (CLI not in path)
56-
57-
1. Determine where the Robusta-cli binary file is located
58-
59-
.. code-block:: bash
60-
:name: cb-find-python-cli-loc
61-
62-
find / -regex '.*/bin/robusta' 2>/dev/null
63-
64-
2. Add the path you found (e.g ``/opt/homebrew/bin/``) to your PATH. To do so, find your shell config file ( ~/.profile or ~/.bash_profile or ~/.zshrc etc...) and append the following:
65-
66-
.. code-block:: bash
67-
:name: add-path-var
68-
69-
export PATH="$PATH:<new-path>"
70-
71-
3. Reopen the terminal or run:
72-
73-
.. code-block:: bash
74-
:name: cb-refresh-terminal
75-
76-
source <your-shell-config-file>
77-
78-
.. admonition:: Alternative Solution
79-
80-
Instead of modifying PATH, run Robusta commands via the python3 binary: ``python3 -m robusta.cli.main gen-config``
81-
82-
.. details:: SSL certificate errors on Mac OS
83-
84-
This implies a python package with certificates is missing on your system.
85-
86-
To fix it, run ``/Applications/Python 3.9/Install Certificates.command``
87-
88-
For more info see:
89-
https://stackoverflow.com/questions/52805115/certificate-verify-failed-unable-to-get-local-issuer-certificate
90-
91-
Phase 2: Helm Installation
49+
Phase 1: Helm Installation
9250
^^^^^^^^^^^^^^^^^^^^^^^^^^
9351

9452
Problems when running ``helm install`` command or installing via GitOps.
@@ -128,7 +86,7 @@ Problems when running ``helm install`` command or installing via GitOps.
12886

12987
Follow this guide for :ref:`upgrading CRDs from an older version <Manual Upgrade>`.
13088

131-
Phase 3: Runtime Issues
89+
Phase 2: Runtime Issues
13290
^^^^^^^^^^^^^^^^^^^^^^^
13391

13492
Issues after installation when pods are running but not working correctly.
@@ -252,7 +210,7 @@ Holmes
252210

253211
See :ref:`Using Existing Secrets <Reading the Robusta UI Token from a secret in HolmesGPT>` to configure Holmes to read the ``token``
254212

255-
Phase 4: Integration Issues
213+
Phase 3: Integration Issues
256214
^^^^^^^^^^^^^^^^^^^^^^^^^^^
257215

258216
Problems with external service integrations after Robusta is running.

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
.. toctree::
4545
:maxdepth: 4
46-
:caption: Other Features
46+
:caption: Robusta Classic
4747
:hidden:
4848

4949
Send Alerts to Robusta <configuration/index>

docs/setup-robusta/installation/_generate_config.jinja

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

docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst

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

docs/setup-robusta/installation/all-in-one-installation.rst

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

0 commit comments

Comments
 (0)