Merge branch 'main' into issue-2097-widget

nastasha-solomon · web-flow · commit d15a5403ad78 · 2022-08-12T11:51:55.000-04:00
diff --git a/README.md b/README.md
@@ -9,10 +9,23 @@ Please view this template for guidance on creating issues: https://github.com/el
 ## Contributing to Elastic Security docs
 
 If you are an Elastic employee and would like to contribute to Elastic Security documentation: 
+
 1. Please clone and fork the `security-docs` repo. 
 2. Open an issue using the appropriate [template](https://github.com/elastic/security-docs/tree/master/.github/ISSUE_TEMPLATE).
 3. Check out the `main` branch and fetch the latest changes. 
 4. Check out a new branch and make your changes. 
 5. Save your changes and open a pull request. 
-6. Tag the the `@security-docs` team and any other appropriate reviewers. We'll take care of merging and backporting.  
+6. Add the `[@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs)` team and any other appropriate members as reviewers. 
+7. Add the appropriate release version label, backport version label if appropriate, and team label to the PR. 
+8. Once the docs team approves all changes, you can merge it. If a backport version label was added to a PR for stack versions 7.14.0 and newer, mergify will automatically open a backport PR. 
+9. Merge the backport PR once it passes all CI checks. 
+
+### Preview documentation changes
+
+Once the PR is opened, and the build complete, the changes can be previewed via this URL (replace `<YOUR_PR_NUMBER_HERE>` with the PR number):
+
+```
+https://security-docs_<YOUR_PR_NUMBER_HERE>.docs-preview.app.elstc.co/guide/en/security/master
+```
+
 
diff --git a/docs/detections/alerts-ui-manage.asciidoc b/docs/detections/alerts-ui-manage.asciidoc
@@ -39,7 +39,7 @@ NOTE: When updating alert results to include building block alerts, the Security
 [role="screenshot"]
 image::images/additional-filters.png[Alerts table with Additional filters menu highlighted]
 
-* View detection alerts generated by a specific rule. Go to *Detect* -> *Rules*, then select a rule name in the table. The rule details page displays a comprehensive view of the rule's settings, and the Alerts table under the Trend histogram displays the alerts associated with the rule, including alerts from any previous or deleted revision of that rule.
+* View detection alerts generated by a specific rule. Go to *Manage* -> *Rules*, then select a rule name in the table. The rule details page displays a comprehensive view of the rule's settings, and the Alerts table under the Trend histogram displays the alerts associated with the rule, including alerts from any previous or deleted revision of that rule.
 
 [float]
 [[customize-the-alerts-table]]
diff --git a/docs/detections/api/rules/rules-api-create.asciidoc b/docs/detections/api/rules/rules-api-create.asciidoc
@@ -394,7 +394,7 @@ a value from the source event:
 
 |rule_name_override |String |Sets which field in the source event is used to
 populate the alert's `signal.rule.name` value (in the UI, this value is
-displayed in the *Rule* column on the Detections page). When unspecified, the
+displayed on the *Rules* page in the *Rule* column). When unspecified, the
 rule's `name` value is used. The source field must be a string data type.
 
 |severity_mapping |Object[] a|Overrides generated alerts' `severity` with
@@ -550,8 +550,7 @@ All fields are required:
 |==============================================
 
 NOTE: Only threats described using the MITRE ATT&CK^TM^ framework are displayed
-in the UI (*Detections* -> *Manage detection rules* -> <rule
-name>).
+in the UI (*Manage* -> *Rules* -> *_Rule name_*).
 
 ===== Example requests
 
diff --git a/docs/detections/api/rules/rules-api-export.asciidoc b/docs/detections/api/rules/rules-api-export.asciidoc
@@ -12,7 +12,7 @@ You cannot export prebuilt rules, but they are available at https://github.com/e
 =================
 Although detection rule actions are included in the exported file, the connectors used by the actions are not included. Use the {kibana-ref}/managing-saved-objects.html#managing-saved-objects-export-objects[Saved Objects] UI in Kibana (*Stack Management* -> *Kibana* -> *Saved Objects*) or the Saved Objects APIs (experimental) to {kibana-ref}/saved-objects-api-export.html[export] and {kibana-ref}/saved-objects-api-import.html[import] any necessary connectors _before_ you export and import the detection rules.
 
-Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <<edit-value-lists, Upload value lists>> UI (*Detect* -> *Rules* -> *Upload value lists*) to export and import value lists separately.
+Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <<edit-value-lists, Upload value lists>> UI (*Manage* -> *Rules* -> *Upload value lists*) to export and import value lists separately.
 =================
 
 ==== Request URL
diff --git a/docs/detections/api/rules/rules-api-import.asciidoc b/docs/detections/api/rules/rules-api-import.asciidoc
@@ -14,7 +14,7 @@ NOTE: You need at least `Read` privileges for the `Action and Connectors` featur
 =================
 Although detection rule actions are included in the exported file, the connectors used by the actions are not included. Use the {kibana-ref}/managing-saved-objects.html#managing-saved-objects-export-objects[Saved Objects] UI in Kibana (*Stack Management* -> *Kibana* -> *Saved Objects*) or the Saved Objects APIs (experimental) to {kibana-ref}/saved-objects-api-export.html[export] and {kibana-ref}/saved-objects-api-import.html[import] any necessary connectors _before_ you export and import the detection rules.
 
-Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <<edit-value-lists, Upload value lists>> UI (*Detect* -> *Rules* -> *Upload value lists*) to export and import value lists separately.
+Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <<edit-value-lists, Upload value lists>> UI (*Manage* -> *Rules* -> *Upload value lists*) to export and import value lists separately.
 =================
 
 ==== Request URL
diff --git a/docs/detections/api/rules/rules-api-update.asciidoc b/docs/detections/api/rules/rules-api-update.asciidoc
@@ -310,7 +310,7 @@ a value from the source event:
 
 |rule_name_override |String |Sets which field in the source event is used to
 populate the alert's `signal.rule.name` value (in the UI, this value is
-displayed in the *Rule* column on the Detections page). When unspecified, the
+displayed on the *Rules* page in the *Rule* column). When unspecified, the
 rule's `name` value is used. The source field must be a string data type.
 
 |severity_mapping |Object[] a|Overrides generated alerts' `severity` with
@@ -427,8 +427,7 @@ technique:
 |==============================================
 
 NOTE: Only threats described using the MITRE ATT&CK^TM^ framework are displayed
-in the UI (*Security* -> *Detections* -> *Manage detection rules* -> <rule
-name>).
+in the UI (*Manage* -> *Rules* -> *_Rule name_*).
 
 ===== Example request
 
diff --git a/docs/detections/building-block-rule.asciidoc b/docs/detections/building-block-rule.asciidoc
@@ -26,7 +26,7 @@ image::images/alert-indices-ui.png[]
 By default, building block alerts are excluded from the Overview and Alerts pages.
 You can choose to include building block alerts on the Alerts page, which expands the number of alerts.
 
-. Go to *Detect* -> *Alerts*.
+. Go to *Alerts*.
 . In the Alerts table, select *Additional filters* ->
 *Include building block alerts*, located on the far-right.
 
diff --git a/docs/detections/detection-engine-intro.asciidoc b/docs/detections/detection-engine-intro.asciidoc
@@ -3,15 +3,15 @@
 
 = Detections and alerts
 
-Use the Detections feature to create and manage rules, and view the alerts
-these rules create. Rules periodically search indices (such as `endgame-*` and
-`filebeat-*`) for suspicious source events, and create alerts when a rule's
+Use the detection engine to create and manage rules and view the alerts
+these rules create. Rules periodically search indices (such as `logs-*` and
+`filebeat-*`) for suspicious source events and create alerts when a rule's
 conditions are met. When an alert is created, its status is `Open`. To help
-track investigations, an alert's status can be set as `Open`, `Acknowledged`, or
-`Closed` (see <<detection-alert-status>>).
+track investigations, an alert's <<detection-alert-status,status>> can be set as 
+`Open`, `Acknowledged`, or `Closed`.
 
 [role="screenshot"]
-image::images/alert-page.png[Shows the Alerts page]
+image::images/alert-page.png[Alerts page]
 
 In addition to creating <<rules-ui-create, your own rules>>, enable
 <<load-prebuilt-rules, Elastic prebuilt rules>> to immediately start detecting
@@ -195,26 +195,26 @@ NOTE: Ransomware prevention is a paid feature and is enabled by default if you h
 === Resolve UI error messages
 
 Depending on your privileges and whether detection system indices have already
-been created for the {kib} space, you might see an error message  when you try
-to open the *Detections* page.
-
-*`Let’s set up your detection engine`*
-
-If you see this message, a user with specific privileges must visit the
-*Detections* page before you can view detection rules and alerts.
-See <<enable-detections-ui>> for a list of all the requirements.
+been created for the {kib} space, you might get one of these error messages when you 
+open the *Alerts* or *Rules* page:
 
+* *`Let’s set up your detection engine`*
++
+If you get this message, a user with specific privileges must visit the
+*Alerts* or *Rules* page before you can view detection alerts and rules.
+Refer to <<enable-detections-ui>> for a list of all the requirements.
++
 NOTE: For *self-managed* {stack} deployments only, this message may be displayed
 when the
 <<detections-permissions, `xpack.encryptedSavedObjects.encryptionKey`>>
-setting has not been added to the `kibana.yml` file. For more information, see <<detections-on-prem-requirements>>.
+setting has not been added to the `kibana.yml` file. For more information, refer to <<detections-on-prem-requirements>>.
 
-*`Detection engine permissions required`*
-
-If you see this message, you do not have the
+* *`Detection engine permissions required`*
++
+If you get this message, you do not have the
 <<detections-permissions, required privileges>> to view the *Detections* feature,
 and you should contact your {kib} administrator.
-
++
 NOTE: For *self-managed* {stack} deployments only, this message may be
 displayed when the <<detections-permissions, `xpack.security.enabled`>>
-setting is not enabled in the `elasticsearch.yml` file. For more information, see <<detections-on-prem-requirements>>.
+setting is not enabled in the `elasticsearch.yml` file. For more information, refer to <<detections-on-prem-requirements>>.
diff --git a/docs/detections/detections-ui-exceptions.asciidoc b/docs/detections/detections-ui-exceptions.asciidoc
@@ -41,7 +41,7 @@ act as value delimiters.
 * Wildcards are not supported in rule exceptions or value lists. Values must be literal values.
 =========================
 
-. Go to *Detect* -> *Rules*.
+. Go to *Manage* -> *Rules*.
 . Click *Upload value lists*. The *Upload value lists* window opens.
 +
 [role="screenshot"]
@@ -60,7 +60,7 @@ the new file are appended to the previously uploaded values.
 
 To view, delete, or export existing value lists:
 
-. Go to *Detect* -> *Rules*.
+. Go to *Manage* -> *Rules*.
 . Click *Upload value lists*. The *Upload value lists* window opens.
 . In the *Value lists* table, click the required action button.
 
@@ -101,15 +101,15 @@ specific event in the sequence, update the rule's EQL statement. For example:
 --
 * To add an exception from the rule details page:
 .. Go to the rule details page of the rule to which you want to add an
-exception (*Detect* -> *Rules* -> *_<Rule name>_*).
+exception (*Manage* -> *Rules* -> *_<Rule name>_*).
 .. Scroll down below the rule details and select the *Exceptions* tab.
 +
 [role="screenshot"]
 image::images/exception-histogram.png[Detail of Exceptions tab, 75%]
 .. Click *Add new exception* -> *Add rule exception*.
 
 * To add an exception from the Alerts table:
-.. Go to *Detect* -> *Alerts*.
+.. Go to *Alerts*.
 .. Scroll down to the Alerts table, go to the alert you want to create an exception for, click the *More Actions* menu (*...*), then select *Add rule exception*.
 
 The *Add Rule Exception* flyout opens (the example below was opened from the Alerts table):
@@ -182,11 +182,11 @@ Additionally, to add an Endpoint exception to the Elastic Endpoint Security rule
 +
 --
 * To add an Endpoint exception from the rule details page:
-.. Go to the rule details page (*Detect* -> *Rules*), and then search for and  select the Elastic *Endpoint Security* rule.
+.. Go to the rule details page (*Manage* -> *Rules*), and then search for and  select the Elastic *Endpoint Security* rule.
 .. Scroll down to the *Trend* histogram and select the *Exceptions* tab.
 .. Click *Add new exception* -> *Add Endpoint exception*.
 * To add an Endpoint exception from the Alerts table:
-.. Go to *Detect* -> *Alerts*.
+.. Go to *Alerts*.
 .. Scroll down to the Alerts table, and from an {elastic-endpoint} 
 alert, click the *More actions* menu (*...*), then select *Add Endpoint exception*.
 --
@@ -275,7 +275,7 @@ image::images/nested-exp.png[]
 [[manage-exceptions]]
 === View and manage exception lists
 
-The Exception lists table enables you to view and manage all exceptions that have been assigned to rules. To view the Exception lists table, go to *Detect* -> *Exception lists*.
+The Exception lists table enables you to view and manage all exceptions that have been assigned to rules. To view the Exception lists table, go to *Manage* -> *Exception lists*.
 
 [role="screenshot"]
 image::images/exceptions-page.png[]
diff --git a/docs/detections/machine-learning/machine-learning.asciidoc b/docs/detections/machine-learning/machine-learning.asciidoc
@@ -3,8 +3,8 @@
 = Anomaly Detection with Machine Learning
 
 {ml-docs}/ml-ad-overview.html[{ml-cap}] functionality is available when
-you have the *{subscriptions}[appropriate license]*, are
-using a *{ess-trial}[cloud deployment]*, or are testing out a *Free Trial*.
+you have the appropriate subscription, are using a *{ess-trial}[cloud deployment]*,
+or are testing out a *Free Trial*. Refer to <<ml-requirements>>.
 
 You can view the details of detected anomalies within the `Anomalies` table
 widget shown on the Hosts, Network, and associated details pages, or even narrow
diff --git a/docs/detections/prebuilt-rules/tune-rule-signals.asciidoc b/docs/detections/prebuilt-rules/tune-rule-signals.asciidoc
@@ -33,7 +33,7 @@ add an exception for the required application.
 For example, to prevent the <<unusual-process-execution-temp>> rule from
 producing alerts for an in-house application named `myautomatedbuild`:
 
-. Go to *Detect* -> *Rules*.
+. Go to *Manage* -> *Rules*.
 . Search for and then click on the *Unusual Process Execution - Temp* rule.
 +
 The *Unusual Process Execution - Temp* rule details page is displayed.
diff --git a/docs/detections/rules-ui-create.asciidoc b/docs/detections/rules-ui-create.asciidoc
@@ -81,7 +81,7 @@ If a rule requires certain privileges to run, such as index privileges, keep in
 [[create-rule-ui]]
 === Select rule type and scope
 
-. Go to *Detect* -> *Rules* -> *Create new rule*. The *Create new rule* page displays.
+. Go to *Manage* -> *Rules* -> *Create new rule*. The *Create new rule* page displays.
 +
 [role="screenshot"]
 image::images/create-new-rule.png[]
@@ -554,7 +554,7 @@ You uploaded a value list of known ransomware domains, and you want to be notifi
 * *Field*: Enter the field from the Elastic Security event indices to be used for comparing values.
 * *Indicator index field*: Enter the type of value list you created (i.e., `keyword`, `text`, or `IP`).
 +
-TIP: If you don't remember this information, go to *Detect* -> *Rules > Upload value lists*. Locate the appropriate value list and note the field in the corresponding `Type` column. (Examples include keyword, text, and IP.)
+TIP: If you don't remember this information, go to *Manage* -> *Rules* -> *Upload value lists*. Locate the appropriate value list and note the field in the corresponding `Type` column. (Examples include keyword, text, and IP.)
 
 [role="screenshot"]
 image::images/indicator_value_list.png[]
diff --git a/docs/detections/rules-ui-manage.asciidoc b/docs/detections/rules-ui-manage.asciidoc
@@ -38,7 +38,7 @@ NOTE: Searches for index patterns and MITRE ATT&CK tactics and techniques must m
 [[load-prebuilt-rules]]
 === Load and activate prebuilt Elastic rules
 
-To load the {es-sec-app}'s <<prebuilt-rules, prebuilt rules>>, go to *Detect -> Rules -> Load Elastic prebuilt rules and Timeline templates*).
+To load the {es-sec-app}'s <<prebuilt-rules, prebuilt rules>>, go to *Manage* -> *Rules* -> *Load Elastic prebuilt rules and Timeline templates*.
 
 You can then activate whichever rules you want. If you delete any prebuilt rules, a button appears that enables you to reload all of the deleted ones.
 
@@ -54,7 +54,7 @@ To learn how to enable detection rules in Elastic Security, watch the <<enable-d
 [[select-all-prebuilt-rules]]
 === Select and duplicate all prebuilt rules
 
-. Go to *Detect -> Rules*.
+. Go to *Manage* -> *Rules*.
 . Click *Select all _x_ rules* above the rules table.
 . Click *Bulk actions* -> *Duplicate*.
 . Select the *Custom rules* tab.
@@ -90,7 +90,7 @@ You can edit an existing rule's settings, and can bulk edit index patterns, tags
 
 NOTE: For prebuilt Elastic rules, you can't modify most settings. You can only edit <<rule-schedule, rule actions>> and <<detections-ui-exceptions, add exceptions>>.
 
-. Go to *Detect* -> *Rules*.
+. Go to *Manage* -> *Rules*.
 . Do one of the following:
 * Edit a single rule: Select the *All actions* menu (*...*) on a rule, then select *Edit rule settings*. The *Edit rule settings* view opens, where you can modify the <<rules-ui-create, rule's settings>>.
 * Bulk edit multiple rules: Select the rules you want to edit, then select an action from the *Bulk actions* menu:
@@ -107,7 +107,7 @@ NOTE: For prebuilt Elastic rules, you can't modify most settings. You can only e
 
 You can duplicate, enable, disable, and delete rules:
 
-. Go to *Detect* -> *Rules*.
+. Go to *Manage* -> *Rules*.
 . Do one of the following:
 * Select the *All actions* menu (*...*) on a rule, then select an action.
 * Select all the rules you want to modify, then select an action from the *Bulk actions* menu.
@@ -131,7 +131,7 @@ Similarly, any value lists used for rule exceptions are not included in rule exp
 
 To export and import detection rules:
 
-. Go to *Detect* -> *Rules*.
+. Go to *Manage* -> *Rules*.
 . To export rules:
 .. In the rules table, select the rules you want to export.
 .. Select *Bulk actions* -> *Export*, then save the exported file.
diff --git a/docs/detections/rules-ui-monitor.asciidoc b/docs/detections/rules-ui-monitor.asciidoc
@@ -15,7 +15,7 @@ Refer to the <<troubleshoot-signals>> section below for strategies on using thes
 === Rule Monitoring tab
 
 To view a summary of all rule executions, including the most recent failures and execution
-times, select the *Rule Monitoring* tab on the *Rules* page (*Detect* ->
+times, select the *Rule Monitoring* tab on the *Rules* page (*Manage* ->
 *Rules* -> *Rule Monitoring*).
 
 [role="screenshot"]
@@ -33,7 +33,7 @@ For detailed information on a rule, the alerts it generated, and associated erro
 
 Each detection rule execution is logged, including its success or failure, any warning or error messages, and how long it took to search for data, create alerts, and complete. This can help you troubleshoot a particular rule if it isn't behaving as expected (for example, if it isn't creating alerts or takes a long time to run).
 
-To access a rule's execution log, go to *Detect* -> *Rules*, click the rule's name to open its details, then scroll down and select the *Rule execution logs* tab.
+To access a rule's execution log, go to *Manage* -> *Rules*, click the rule's name to open its details, then scroll down and select the *Rule execution logs* tab.
 
 [role="screenshot"]
 image::images/rule-execution-logs.png[Rule execution logs table]
@@ -75,7 +75,7 @@ You can also use Task Manager in {kib} to troubleshoot background tasks and proc
 
 If you see values in the Gaps column in the Rule Monitoring table or on the Rule details page
 for a small number of rules, you can increase those rules'
-Additional look-back time (*Detect* -> *Rules* -> the rule's *All actions* menu (*...*) -> *Edit rule settings* -> *Schedule* -> *Additional look-back time*).
+Additional look-back time (*Manage* -> *Rules* -> the rule's *All actions* menu (*...*) -> *Edit rule settings* -> *Schedule* -> *Additional look-back time*).
 
 It's recommended to set the `Additional look-back time` to at
 least 1 minute. This ensures there are no missing alerts when a rule doesn't
diff --git a/docs/detections/session-view.asciidoc b/docs/detections/session-view.asciidoc
@@ -35,7 +35,7 @@ Session View is accessible from the **Hosts**, **Alerts**, and **Timelines** pag
 Events and sessions that you can investigate in Session View have a rectangular
 *Open Session View* button in the *Actions* column. For example:
 
-* On the Alerts page (*Detect* -> *Alerts*), scroll down to view the Alerts table.
+* On the Alerts page, scroll down to view the Alerts table.
 Look for alerts that have the **Open Session View** button in the **Actions** column:
 [role="screenshot"]
 image::images/session-view-action-icon-detail.png[Detail of the Open Session View icon,width=75%]
diff --git a/docs/detections/visual-event-analyzer.asciidoc b/docs/detections/visual-event-analyzer.asciidoc
diff --git a/docs/getting-started/install-endpoint.asciidoc b/docs/getting-started/install-endpoint.asciidoc
diff --git a/docs/getting-started/ml-req.asciidoc b/docs/getting-started/ml-req.asciidoc
diff --git a/docs/management/admin/host-isolation-ov.asciidoc b/docs/management/admin/host-isolation-ov.asciidoc
