[8.8] [DOCS] Maintenance windows (#157806) (#158019)

# Backport This will backport the following commits from `main` to `8.8`: - [[DOCS] Maintenance windows (#157806)](#157806)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Lisa Cawley <[email protected]>
elastic · May 17, 2023 · a4c256b · a4c256b
1 parent 7117cc9
commit a4c256b
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 1 deletion.
diff --git a/docs/management/maintenance-windows/images/create-maintenance-window.png b/docs/management/maintenance-windows/images/create-maintenance-window.png
diff --git a/docs/management/maintenance-windows/maintenance-windows.asciidoc b/docs/management/maintenance-windows/maintenance-windows.asciidoc
@@ -0,0 +1,49 @@
+[[maintenance-windows]]
+== Maintenance windows
+:description: Maintenance windows enable you to suppress rule notifications.
+:tags-products: [kibana, alerting] 
+:tags-content-type: [overview] 
+:tags-user-goals: [manage]
+
+preview::[]
+
+You can schedule single or recurring maintenance windows to temporarily reduce rule notifications.
+For example, a maintenance window prevents false alarms during planned outages.
+
+Maintenance windows affect all rules in all {kib} apps and spaces.
+Alerts continue to be generated, however notifications are suppressed as follows:
+
+- When an alert occurs during a maintenance window, there are no notifications.
+When the alert recovers, there are no notifications--even if the recovery occurs after the maintenance window ends.
+- When an alert occurs before a maintenance window and recovers during or after the maintenance window, notifications are sent as usual.
+
+[discrete]
+[[setup-maintenance-windows]]
+== Configure access to maintenance windows
+
+To use maintenance windows, you must have the appropriate {subscriptions}[subscription] and {kib} feature privileges.
+
+- To have full access to maintenance windows, you must have `All` privileges for the *Management > Maintenance Windows* feature.
+- To have view-only access to maintenance windows, you must have `Read` privileges for the **Management > Maintenance Windows* feature.
+
+For more details, refer to <<kibana-privileges>>.
+
+[discrete]
+[[manage-maintenance-windows]]
+== Create and manange maintenance windows
+
+In *Management > {stack-manage-app} > Maintenance Windows*, you can create, edit, and archive maintenance windows.
+
+When you create a maintenance window, you must provide a name and a schedule.
+You can optionally configure it to repeat daily, monthly, yearly, or on a custom interval.
+
+[role="screenshot"]
+image::images/create-maintenance-window.png[The Create Maintenance Window user interface in {kib}]
+// NOTE: This is an autogenerated screenshot. Do not edit it directly.
+
+A maintenance window can have any one of the following statuses:
+
+- `Upcoming`: It will run at the scheduled date and time.
+- `Running`: It is running.
+- `Finished`: It ended and does not have a repeat schedule.
+- `Archived`: It is archived. In a future release, archived maintenance windows will be queued for deletion.
diff --git a/docs/user/alerting/create-and-manage-rules.asciidoc b/docs/user/alerting/create-and-manage-rules.asciidoc
@@ -134,6 +134,7 @@ image:images/snooze-panel.png[Snooze notifications for a rule]
 When a rule is in a snoozed state, you can cancel or change the duration of
 this state.
 
+preview:[] To temporarily suppress notifications for _all_ rules, create a <<maintenance-windows,maintenance window>>.
 
 [float]
 [[importing-and-exporting-rules]]

diff --git a/docs/user/management.asciidoc b/docs/user/management.asciidoc
@@ -97,6 +97,9 @@ Viewer or Anomaly Explorer to see your {anomaly-detect} results.
 For example, you might create an alert when the maximum total CPU usage on a machine goes
 above a certain percentage.
 
+| <<maintenance-windows,Maintenance windows>>
+| Suppress rule notifications for scheduled periods of time.
+
 |===
 
 [float]
@@ -184,6 +187,8 @@ include::{kib-repo-dir}/management/action-types.asciidoc[]
 
 include::{kib-repo-dir}/management/managing-licenses.asciidoc[]
 
+include::{kib-repo-dir}/management/maintenance-windows/maintenance-windows.asciidoc[]
+
 include::{kib-repo-dir}/management/manage-data-views.asciidoc[]
 
 include::{kib-repo-dir}/management/numeral.asciidoc[]

diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts
@@ -511,6 +511,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
       indexAction: `${KIBANA_DOCS}index-action-type.html`,
       esQuery: `${KIBANA_DOCS}rule-type-es-query.html`,
       indexThreshold: `${KIBANA_DOCS}rule-type-index-threshold.html`,
+      maintenanceWindows: `${KIBANA_DOCS}maintenance-windows.html`,
       pagerDutyAction: `${KIBANA_DOCS}pagerduty-action-type.html`,
       preconfiguredConnectors: `${KIBANA_DOCS}pre-configured-connectors.html`,
       preconfiguredAlertHistoryConnector: `${KIBANA_DOCS}index-action-type.html#preconfigured-connector-alert-history`,

diff --git a/packages/kbn-doc-links/src/types.ts b/packages/kbn-doc-links/src/types.ts
@@ -391,6 +391,7 @@ export interface DocLinks {
     indexAction: string;
     esQuery: string;
     indexThreshold: string;
+    maintenanceWindows: string;
     pagerDutyAction: string;
     preconfiguredConnectors: string;
     preconfiguredAlertHistoryConnector: string;

diff --git a/x-pack/plugins/alerting/public/pages/maintenance_windows/components/empty_prompt.tsx b/x-pack/plugins/alerting/public/pages/maintenance_windows/components/empty_prompt.tsx
@@ -30,7 +30,7 @@ export const EmptyPrompt = React.memo<EmptyPromptProps>(
           <EuiButtonEmpty
             key="documentation-button"
             target="_blank"
-            href={docLinks.alerting.guide}
+            href={docLinks.alerting.maintenanceWindows}
             iconType="help"
           >
             {i18n.EMPTY_PROMPT_DOCUMENTATION}