Skip to content

Commit

Permalink
[DOCS] Make Cases in the Stack Management GA (elastic#168764)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Oct 16, 2023
1 parent 5c42b9f commit aece2f8
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 18 deletions.
9 changes: 6 additions & 3 deletions docs/management/cases/add-connectors.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
[[add-case-connectors]]
== Add connectors

preview::[]
:frontmatter-description: Configure connectors to push case details to external incident management systems.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]

You can add connectors to cases to push information to these external incident
management systems:
Expand All @@ -24,7 +27,7 @@ You can create connectors in *{stack-manage-app} > {connectors-ui}*,
as described in <<action-types>>. Alternatively, you can create them in
*{stack-manage-app} > Cases*:

. Click *Edit external connection*.
. Click *Settings*.
+
--
[role="screenshot"]
Expand All @@ -50,7 +53,7 @@ configuration details.
You can create additional connectors, update existing connectors, change
the default connector, and change case closure options.

. Go to *{stack-manage-app} > Cases*, click *Edit external connection*.
. Go to *{stack-manage-app} > Cases* and click *Settings*.

. To change whether cases are automatically closed after they are sent to an
external system, update the case closure options.
Expand Down
6 changes: 4 additions & 2 deletions docs/management/cases/cases.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
[[cases]]
== Cases

preview::[]
:frontmatter-description: Open and track issues in {kib} cases.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [overview]
:frontmatter-tags-user-goals: [analyze]

Cases are used to open and track issues directly in {kib}. You can add
assignees and tags to your cases, set their severity and status, and add alerts,
Expand Down
Binary file modified docs/management/cases/images/cases-connectors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/management/cases/images/cases-files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/management/cases/images/cases-visualization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/management/cases/images/cases.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/management/cases/manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [analyze]

preview::[]

[[open-case]]
=== Open a new case

Expand Down
5 changes: 4 additions & 1 deletion docs/management/cases/setup-cases.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
[[setup-cases]]
== Configure access to cases

preview::[]
:frontmatter-description: Learn about the {kib} feature privileges required to access cases.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]

To access cases in *{stack-manage-app}*, you must have the appropriate {kib}
privileges:
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/cases/docs/openapi/bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -3876,7 +3876,7 @@
"from": {
"in": "query",
"name": "from",
"description": "[preview] Returns only cases that were created after a specific date. The date must be specified as a KQL data range or date match expression. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Returns only cases that were created after a specific date. The date must be specified as a KQL data range or date match expression.\n",
"schema": {
"type": "string",
"example": "now-1d"
Expand Down Expand Up @@ -4052,7 +4052,7 @@
"to": {
"in": "query",
"name": "to",
"description": "[preview] Returns only cases that were created before a specific date. The date must be specified as a KQL data range or date match expression. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Returns only cases that were created before a specific date. The date must be specified as a KQL data range or date match expression.\n",
"schema": {
"type": "string"
},
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/cases/docs/openapi/bundled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2354,7 +2354,7 @@ components:
in: query
name: from
description: |
[preview] Returns only cases that were created after a specific date. The date must be specified as a KQL data range or date match expression. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Returns only cases that were created after a specific date. The date must be specified as a KQL data range or date match expression.
schema:
type: string
example: now-1d
Expand Down Expand Up @@ -2480,7 +2480,7 @@ components:
in: query
name: to
description: |
[preview] Returns only cases that were created before a specific date. The date must be specified as a KQL data range or date match expression. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Returns only cases that were created before a specific date. The date must be specified as a KQL data range or date match expression.
schema:
type: string
example: now+1d
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
in: query
name: from
description: >
[preview] Returns only cases that were created after a specific date.
Returns only cases that were created after a specific date.
The date must be specified as a KQL data range or date match expression.
This functionality is in technical preview and may be changed or removed in a future release.
Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
schema:
type: string
example: now-1d
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
in: query
name: to
description: >
[preview] Returns only cases that were created before a specific date.
Returns only cases that were created before a specific date.
The date must be specified as a KQL data range or date match expression.
This functionality is in technical preview and may be changed or removed in a future release.
Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
schema:
type: string
example: now+1d

0 comments on commit aece2f8

Please sign in to comment.