Skip to content

Commit 4b83b01

Browse files
committed
more improvements
1 parent 03bc2b7 commit 4b83b01

22 files changed

Lines changed: 500 additions & 449 deletions

docs/conf.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,11 @@
9292
"configuration/defining-playbooks/creating-notifications.html": "/master/playbook-reference/defining-playbooks/creating-notifications.html",
9393
"configuration/defining-playbooks/external-playbook-repositories.html": "/master/playbook-reference/defining-playbooks/external-playbook-repositories.html",
9494
"configuration/defining-playbooks/index.html": "/master/playbook-reference/defining-playbooks/index.html",
95-
"configuration/defining-playbooks/playbook-advanced.html": "/master/playbook-reference/defining-playbooks/playbook-advanced.html",
96-
"configuration/defining-playbooks/playbook-basics.html": "/master/playbook-reference/defining-playbooks/playbook-basics.html",
97-
"configuration/defining-playbooks/trigger-action-binding.html": "/master/playbook-reference/defining-playbooks/trigger-action-binding.html",
95+
"configuration/defining-playbooks/playbook-advanced.html": "/master/playbook-reference/index.html",
96+
"playbook-reference/defining-playbooks/playbook-advanced.html": "/master/playbook-reference/index.html",
97+
"configuration/defining-playbooks/playbook-basics.html": "/master/playbook-reference/index.html",
98+
"configuration/defining-playbooks/trigger-action-binding.html": "/master/playbook-reference/index.html#matching-actions-to-triggers",
99+
"playbook-reference/defining-playbooks/trigger-action-binding.html": "/master/playbook-reference/index.html#matching-actions-to-triggers",
98100
"configuration/additional-settings.html": "/master/setup-robusta/additional-settings.html",
99101
"developer-guide/writing-playbooks.html": "/master/playbook-reference/defining-playbooks/index.html",
100102
"user-guide/slack.html": "/master/configuration/sinks/slack.html",
@@ -168,7 +170,7 @@
168170
"user-guide/embedded-prometheus.html": "/master/configuration/alertmanager-integration/embedded-prometheus.html#enabling-the-embedded-prometheus",
169171
"user-guide/node-selector.html": "/master/setup-robusta/node-selector.html",
170172
"user-guide/interactivity.html": "/master/setup-robusta/additional-settings.html#two-way-interactivity",
171-
"user-guide/flow-control.html": "/master/playbook-reference/defining-playbooks/playbook-advanced.html#using-filters-to-restrict-triggers",
173+
"user-guide/flow-control.html": "/master/playbook-reference/index.html#using-filters-to-restrict-triggers",
172174
"catalog/triggers/index.html": "/master/playbook-reference/triggers/index.html",
173175
"catalog/triggers/kubernetes.html": "/master/playbook-reference/triggers/kubernetes.html",
174176
"catalog/triggers/smart.html": "/master/playbook-reference/triggers/kubernetes.html",
@@ -190,7 +192,7 @@
190192
"catalog/sinks/webex.html": "/master/configuration/sinks/webex.html",
191193
"catalog/sinks/VictorOps.html": "/master/configuration/sinks/VictorOps.html",
192194
"catalog/sinks/file.html": "/master/configuration/sinks/file.html",
193-
"user-guide/trigger-action-binding.html": "/master/playbook-reference/defining-playbooks/playbook-basics.html#understanding-actions",
195+
"user-guide/trigger-action-binding.html": "/master/playbook-reference/index.html#understanding-actions",
194196
"advanced/privacy-and-security.html": "/master/setup-robusta/privacy-and-security.html",
195197
"advanced/robusta-ui-triggers.html": "/master/setup-robusta/installation/index.html",
196198
"developer-guide/actions/index.html": "/master/playbook-reference/actions/index.html",
@@ -210,7 +212,9 @@
210212
"configuration/alertmanager-integration/troubleshooting-alertmanager.html": "/master/configuration/exporting/send-alerts-api.html",
211213
"configuration/alertmanager-integration/grafana-alert-manager.html": "/master/configuration/alertmanager-integration/grafana-self-hosted.html",
212214
"configuration/alertmanager-integration/grafana-cloud-mimir.html": "/master/configuration/alertmanager-integration/grafana-cloud.html",
213-
"playbook-reference/what-are-playbooks.html": "/master/playbook-reference/overview.html",
215+
"playbook-reference/what-are-playbooks.html": "/master/playbook-reference/index.html",
216+
"playbook-reference/overview.html": "/master/playbook-reference/index.html",
217+
"playbook-reference/defining-playbooks/playbook-basics.html": "/master/playbook-reference/index.html",
214218
"how-it-works/alert-builtin-enrichment.html": "/master/playbook-reference/builtin-alert-enrichment.html",
215219
"setup-robusta/installation/extend-prometheus-installation.html": "/master/setup-robusta/installation/standalone-installation.html",
216220
"playbook-reference/defining-playbooks/index.html": "/master/playbook-reference/index.html",

docs/help.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:hide-toc:
22

3+
.. _Getting Support:
4+
35
Getting Support
46
================
57

docs/index.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,14 @@
144144
:hidden:
145145

146146
playbook-reference/index
147-
Enrich Alerts <playbook-reference/builtin-alert-enrichment>
148-
Kubernetes Change Notifications <playbook-reference/kubernetes-examples/kubernetes-change-notifications>
147+
Playbook Notifications <playbook-reference/defining-playbooks/creating-notifications>
148+
Alert Enrichment <playbook-reference/builtin-alert-enrichment>
149+
Automatic Remediation <playbook-reference/automatic-remediation-examples/index>
150+
Silencer Playbooks <playbook-reference/defining-playbooks/silencer-playbooks>
151+
Triggers Reference <playbook-reference/triggers/index>
152+
Actions Reference <playbook-reference/actions/index>
153+
Log Based Alerting <playbook-reference/logs-triggers/index>
154+
K8s Change Notification <playbook-reference/kubernetes-examples/kubernetes-change-notifications>
149155
Cost Savings - KRR <configuration/resource-recommender>
150156

151157
.. toctree::

docs/notification-routing/routing-silencing.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,5 @@ node that just restarted.
3535
Further Reading
3636
-----------------
3737

38+
* Learn more about :ref:`Silencer Playbooks <Silencer Playbooks>`
3839
* View all :ref:`Prometheus Silencer <Prometheus Silencers>` actions

docs/playbook-reference/actions/develop-actions/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Please consider sharing your custom actions with the community.
1818
my-first-custom-action
1919
playbook-repositories
2020
loading-custom-actions
21+
Loading External Actions <../../defining-playbooks/external-playbook-repositories>
2122
overriding-builtin-actions
2223
findings-api
2324
triggers-and-events

docs/playbook-reference/actions/develop-actions/loading-custom-actions.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Loading Custom Actions into Robusta:
2+
13
Loading Custom Actions into Robusta
24
####################################
35

docs/playbook-reference/actions/develop-actions/playbook-repositories.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Creating Playbook Repositories:
2+
13
Creating Playbook Repositories
24
################################
35

docs/playbook-reference/actions/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:hide-toc:
22

3+
.. _Actions Reference:
4+
35
Actions Reference
46
==================
57

docs/playbook-reference/builtin-alert-enrichment.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _builtin-alert-enrichment:
22

3-
Enrich Alerts
3+
Alert Enrichment
44
########################################
55

66
Ever feel overwhelmed by alerts that lack context? Robusta enriches alerts automatically and lets you create custom enrichment rules.

docs/playbook-reference/defining-playbooks/external-playbook-repositories.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Loading External Actions:
2+
13
Loading External Actions
24
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35

0 commit comments

Comments
 (0)