Merge pull request #5 from machadovilaca/update-alert-validation-doc

Mention our custom alert validations in documentation
machadovilaca · Feb 28, 2024 · 4df875e · 4df875e
2 parents 6720f1d + 0993e86
commit 4df875e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/AlertsAndRecordingRulesValidation.md b/docs/AlertsAndRecordingRulesValidation.md
@@ -53,6 +53,9 @@ type AlertValidation = func(alert *promv1.Rule) []Problem
 func (linter *Linter) AddCustomAlertValidations(validations ...AlertValidation)
 ```
 
+You can define your own alert validation rules or use some custom validations exported and
+available for usage in [pkg/testutil/alert_custom_validations.go](../pkg/testutil/alert_custom_validations.go).
+
 ### Linting
 
 `LintRecordingRules(recordingRules []operatorrules.RecordingRule) []Problem`: