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

…g information. (elastic#92564) * [Alerts][Docs] Extended README.md and the user docs with the licensing information. * Apply suggestions from code review Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: gchaps <[email protected]> * fixed due to comments Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: gchaps <[email protected]>
YulNaumenko · Feb 25, 2021 · 7756da7 · 7756da7
1 parent 8229024
commit 7756da7
Show file tree

Hide file tree

Showing 2 changed files with 24 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 subscription features, while others are free features.
+For a comparison of the Elastic subscription levels,
+see {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,19 @@ For example, if the `context` has one variable `foo` which is an object that has
 }
 ```
 
+## Licensing
+
+Currently most of the alerts are free features. But some alert types are subscription features, such as the tracking containment alert.
+
+## Documentation
+
+You should create documentation for the new alert type. Make an entry in the alert type index [`docs/user/alerting/alert-types.asciidoc`](../../../docs/user/alerting/alert-types.asciidoc) that points to a new document for the alert type that should be in the proper application directory.
+
+## Tests
+
+The alert type should have jest tests and optionaly functional tests. 
+In the the tests we recomend to test the expected alert execution result with a different input params, the structure of the created alert and the params validation. The rest will be guaranteed as a framework functionality.
+
 ### 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.