[Alerts][Docs] Extended README.md and the user docs with the licensin…

…g information.
elastic · Feb 24, 2021 · 633435d · 633435d
1 parent 1f1f703
commit 633435d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/user/alerting/alert-types.asciidoc b/docs/user/alerting/alert-types.asciidoc
@@ -30,6 +30,14 @@ For domain-specific alerts, refer to the documentation for that app.
 * <<geo-alerting, Maps alerts>>
 * <<xpack-ml, ML alerts>>
 
+[NOTE]
+==============================================
+Some alert types are paid commercial features, while others are free.
+For a comparison of the Elastic subscription levels,
+see https://www.elastic.co/subscriptions[the subscription page].
+==============================================
+
+
 include::stack-alerts/index-threshold.asciidoc[]
 include::stack-alerts/es-query.asciidoc[]
 include::maps-alerts/geo-alert-types.asciidoc[]
diff --git a/x-pack/plugins/alerts/README.md b/x-pack/plugins/alerts/README.md
@@ -17,6 +17,9 @@ Table of Contents
 	- [Alert types](#alert-types)
 		- [Methods](#methods)
 		- [Executor](#executor)
+		- [Licensing](#licensing)
+		- [Documentation](#documentation)
+		- [Tests](#tests)
 		- [Example](#example)
 	- [Role Based Access-Control](#role-based-access-control)
 	- [Alert Navigation](#alert-navigation)
@@ -124,6 +127,18 @@ For example, if the `context` has one variable `foo` which is an object that has
 }
 ```
 
+## Licensing
+
+Currently most of the alerts are licensed as "basic". But some alert types are at least "gold" level, eg tracking containment alert.
+
+## Documentation
+
+You should also create some asciidoc for the new alert type. An entry should be made in the alert type index - [`docs/user/alerting/alert-types.asciidoc`](../../../docs/user/alerting/alert-types.asciidoc) which points to a new document for the alert type that should be in the directory [`docs/user/alerting/alert-types`](../../../docs/user/alerting/alert-types).
+
+## Tests
+
+The alert type should have both jest tests and functional tests.
+
 ### Example
 
 This example receives server and threshold as parameters. It will read the CPU usage of the server and schedule actions to be executed (asynchronously by the task manager) if the reading is greater than the threshold.