Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Maintenance window column in alerts tables #158125

Merged
merged 3 commits into from
May 23, 2023
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 19, 2023

Summary

Relates to #153775, #157806 (review)

This PR updates the "Maintenance windows" and "Create and manage rules" pages in the Kibana Guide to describe the maintenance windows ID that appears in alert details. From testing this feature, it seems that the identifier information persists even after the window is cancelled/finished and there is no obvious mapping of ID to maintenance window title, so the value of this information is simply to indicate that an alert is/was affected by a window at some point.

The PR also refreshes the automated screenshot such that it shows the new Maintenance Windows column.

@lcawl lcawl added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.8.0 v8.9.0 labels May 19, 2023
@github-actions
Copy link

Documentation preview:

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl mentioned this pull request May 19, 2023
31 tasks
@lcawl lcawl marked this pull request as ready for review May 19, 2023 01:47
@lcawl lcawl requested a review from a team as a code owner May 19, 2023 01:47
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

- `Archived`: It is archived. In a future release, archived maintenance windows will be queued for deletion.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@JiaweiWu JiaweiWu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@lcawl lcawl merged commit 1b71d2c into elastic:main May 23, 2023
@lcawl lcawl deleted the maint-ids branch May 23, 2023 17:50
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 23, 2023
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl mentioned this pull request May 23, 2023
6 tasks
kibanamachine added a commit that referenced this pull request May 23, 2023
…58301)

# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Maintenance window column in alerts tables
(#158125)](#158125)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-05-23T17:49:18Z","message":"[DOCS]
Maintenance window column in alerts tables
(#158125)","sha":"1b71d2ca3c7b0492e88f44c70ab08f60acb47435","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:prev-minor","v8.8.0","v8.9.0"],"number":158125,"url":"https://github.com/elastic/kibana/pull/158125","mergeCommit":{"message":"[DOCS]
Maintenance window column in alerts tables
(#158125)","sha":"1b71d2ca3c7b0492e88f44c70ab08f60acb47435"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/158125","number":158125,"mergeCommit":{"message":"[DOCS]
Maintenance window column in alerts tables
(#158125)","sha":"1b71d2ca3c7b0492e88f44c70ab08f60acb47435"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
delanni pushed a commit to delanni/kibana that referenced this pull request May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.8.0 v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants