Skip to content

Commit

Permalink
Case custom fields GA (#4084)
Browse files Browse the repository at this point in the history
* Move custom fields to settings page

* Replace tech-preview with added callouts

* Edit custom fields content

* Add custom field details in Serverless docs

* Add links to case settings page

* Change callout to badge
  • Loading branch information
lcawl authored Aug 6, 2024
1 parent 406f676 commit 3fe0031
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 44 deletions.
Binary file not shown.
Binary file modified docs/en/observability/images/cases-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/en/observability/manage-cases-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,28 @@ To update an existing connector:
. Click *Update <connector name>*.
. Update the connector fields as required.

[float]
[[case-custom-fields]]
== Custom fields

You can add optional and required fields for customized case collaboration. added:[8.15.0]

. In the *Custom fields* section, click *Add field*.
+
--
[role="screenshot"]
image::images/cases-add-custom-field.png[Add a custom field in case settings]
//NOTE: This is an autogenerated screenshot. Do not edit it directly.
--

. You must provide a field label and type (text or toggle).
You can optionally designate it as a required field and provide a default value.

When you create a custom field, it's added to all new and existing cases.
In existing cases, new custom text fields initially have null values.

You can subsequently remove or edit custom fields on the *Settings* page.

[discrete]
[[observability-case-templates]]
== Templates
Expand Down
44 changes: 2 additions & 42 deletions docs/en/observability/manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,60 +10,20 @@ To perform these tasks, you must have <<grant-cases-access,full access>> to the
Open a new case to keep track of issues and share the details with colleagues.

. Go to *Cases* -> *Create new case*.
. preview:[] If you defined <<observability-case-templates,templates>>, optionally select one to use its default field values.
. If you defined <<observability-case-templates,templates>>, optionally select one to use its default field values. preview:[]
. Give the case a name, severity, and description.
+
TIP: In the `Description` area, you can use
https://www.markdownguide.org/cheat-sheet[Markdown] syntax to create formatted text.

. Optionally, add a category, assignees, and tags.
You can add users only if they meet the necessary <<grant-cases-access,prerequisites>>.
. preview:[] If you defined <<case-custom-fields,custom fields>>, they appear in the *Additional fields* section.
. If you defined <<case-custom-fields,custom fields>>, they appear in the *Additional fields* section. added:[8.15.0]
. Under External incident management system, select a <<cases-external-connectors,connector>>. If
you've previously added one, that connector displays as the default selection. Otherwise, the
default setting is `No connector selected`.
. After you've completed all of the required fields, click *Create case*.

[float]
[[case-custom-fields]]
== Add custom fields

preview::[]

You can add optional and required fields for customized case collaboration.

. Go to *Cases* -> *Settings*.
+
--
[role="screenshot"]
image::images/cases-custom-field-settings.png[View custom fields in case settings]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.
--

. In the *Custom fields* section, click *Add field*.
+
--
[role="screenshot"]
image::images/cases-add-custom-field.png[Add a custom field in case settings]
//NOTE: This is an autogenerated screenshot. Do not edit it directly.
--

. Enter a field label.

. Choose a field type: text or toggle.

. If you want the text field to be mandatory in all cases, select *Make this field required*.

. Optionally add a default value.

. Click *Save field*.

You can subsequently remove or edit custom fields on the *Settings* page.

After you create custom fields, they're added to all new and existing cases.

Existing cases have null values for the new text fields until you set them in each case.

[float]
[[add-case-notifications]]
== Add email notifications
Expand Down
4 changes: 3 additions & 1 deletion docs/en/serverless/cases/create-manage-cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To create a case in your Observability project:

1. In your ((observability)) project, go to **Cases**.
1. Click **Create case**.
1. (Optional) If you defined templates, select one to use its default field values. <DocCallOut template="technical_preview" />
1. (Optional) If you defined <DocLink slug="/serverless/observability/case-settings" section="templates">templates</DocLink>, select one to use its default field values. <DocBadge template="technical preview" />
1. Give the case a name, severity, and description.

<DocCallOut title="Tip">
Expand All @@ -29,6 +29,8 @@ To create a case in your Observability project:
(all I know is that they can _view_ the case) */}
You can add users who are assigned the Editor user role (or a more permissive role) for the project.

1. If you defined <DocLink slug="/serverless/observability/case-settings" section="custom-fields">custom fields</DocLink>, they appear in the **Additional fields** section.

1. (Optional) Under External incident management system, you can select a connector to send cases to an external system.
If you've created any connectors previously, they will be listed here.
If there are no connectors listed, you can <DocLink slug="/serverless/observability/case-settings">create one</DocLink>.
Expand Down
21 changes: 20 additions & 1 deletion docs/en/serverless/cases/manage-cases-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,26 @@ To update an existing connector:
1. Click **Update \<connector name>**.
1. Update the connector fields as required.

## Case templates
## Custom fields

You can add optional and required fields for customized case collaboration.

To create a custom field:

1. In the **Custom fields** section, click **Add field**.

![Add a custom field](../images/observability-cases-custom-fields.png)
{/* NOTE: This is an autogenerated screenshot. Do not edit it directly. */}

1. You must provide a field label and type (text or toggle).
You can optionally designate it as a required field and provide a default value.

When you create a custom field, it's added to all new and existing cases.
In existing cases, new custom text fields initially have null values.

You can subsequently remove or edit custom fields on the **Settings** page.

## Templates

<DocCallOut template="technical_preview" />

Expand Down
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/en/serverless/images/observability-cases-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3fe0031

Please sign in to comment.