diff options
Diffstat (limited to 'doc/operations/incident_management')
10 files changed, 47 insertions, 29 deletions
diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index 7e4223c0820..32603aa3753 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Alerts **(FREE)** @@ -13,7 +13,7 @@ Alerts are a critical entity in your incident management workflow. They represen Users with at least the Developer role can access the Alert list at **Monitor > Alerts** in your project's sidebar. The Alert list displays alerts sorted by start time, but -you can change the sort order by clicking the headers in the Alert list. +you can change the sort order by selecting the headers in the Alert list. The alert list displays the following information: diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md index 56ff733e395..87455906b26 100644 --- a/doc/operations/incident_management/escalation_policies.md +++ b/doc/operations/incident_management/escalation_policies.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Escalation Policies **(PREMIUM)** diff --git a/doc/operations/incident_management/incident_timeline_events.md b/doc/operations/incident_management/incident_timeline_events.md index 743f9b429d6..5f98335d7aa 100644 --- a/doc/operations/incident_management/incident_timeline_events.md +++ b/doc/operations/incident_management/incident_timeline_events.md @@ -1,16 +1,14 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Timeline events -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344059) in GitLab 15.2 [with a flag](../../administration/feature_flags.md) named `incident_timeline`. Enabled by default. - -FLAG: -On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable the feature flag](../../administration/feature_flags.md) named `incident_timeline`. -On GitLab.com, this feature is available. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344059) in GitLab 15.2 [with a flag](../../administration/feature_flags.md) named `incident_timeline`. Enabled by default. +> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/353426) in GitLab 15.3. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/353426) in GitLab 15.5. [Feature flag 'incident_timeline'](https://gitlab.com/gitlab-org/gitlab/-/issues/343386) removed. Incident timelines are an important part of record keeping for incidents. Timelines can show executives and external viewers what happened during an incident, diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 2cb2e5f8045..edbe07f166c 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Incidents **(FREE)** @@ -10,9 +10,6 @@ Incidents are critical entities in incident management workflows. They represent a service disruption or outage that needs to be restored urgently. GitLab provides tools for the triage, response, and remediation of incidents. -Users with at least Guest [permissions](../../user/permissions.md) can access -incidents [on public projects](../../user/permissions.md#project-members-permissions). - ## Incident creation You can create an incident manually or automatically. @@ -86,8 +83,14 @@ confirm that a GitLab incident is created from the incident. ## Incident list -For users with at least Guest [permissions](../../user/permissions.md), the -Incident list is available at **Monitor > Incidents** +Whether you can view an incident depends on the [project visibility level](../../user/public_access.md) and +the incident's confidentiality status: + +- Public project and a non-confidential incident: You don't have to be a member of the project. +- Private project and non-confidential incident: You must have at least the Guest role for the project. +- Confidential incident (regardless of project visibility): You must have at least the Reporter. + +The Incident list is available at **Monitor > Incidents** in your project's sidebar. The list contains the following metrics:  @@ -138,10 +141,9 @@ For a live example of the incident list in action, visit this > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230847) in GitLab 13.4. -Users with at least Guest [permissions](../../user/permissions.md) can view -the Incident Details page. Navigate to **Monitor > Incidents** in your project's -sidebar, and select an incident from the list. - +1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Incidents**. +1. Select an incident from the list. When you take any of these actions on an incident, GitLab logs a system note and displays it in the Incident Details view: @@ -192,7 +194,7 @@ When you upload an image, you can associate the image with text or a link to the  -If you add a link, you can access the original graph by clicking the hyperlink above the uploaded image. +If you add a link, you can access the original graph by selecting the hyperlink above the uploaded image. ### Alert details diff --git a/doc/operations/incident_management/index.md b/doc/operations/incident_management/index.md index 3b38d4ab427..9e66ab46692 100644 --- a/doc/operations/incident_management/index.md +++ b/doc/operations/incident_management/index.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Incident management **(FREE)** diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index 6e65fe875c5..ae6ffe549d5 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Integrations **(FREE)** diff --git a/doc/operations/incident_management/linked_resources.md b/doc/operations/incident_management/linked_resources.md index 3fe4a325cdb..4c3ef34f634 100644 --- a/doc/operations/incident_management/linked_resources.md +++ b/doc/operations/incident_management/linked_resources.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Linked resources in incidents **(PREMIUM)** @@ -50,6 +50,24 @@ To add a linked resource: 1. Complete the required fields. 1. Select **Add**. +### Using a quick action **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374964) in GitLab 15.5. + +To add multiple links to an incident, use the `/link` +[quick action](../../user/project/quick_actions.md): + +```plaintext +/link https://example.link.us/j/123456789 +``` + +You can also submit a short description with the link. +The description shows instead of the URL in the **Linked resources** section of the incident: + +```plaintext +/link https://example.link.us/j/123456789, multiple alerts firing +``` + ### Link Zoom meetings from an incident **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230853) in GitLab 15.4. @@ -63,7 +81,7 @@ Use the `/zoom` [quick action](../../user/project/quick_actions.md) to add multi You can also submit a short optional description with the link. The description shows instead of the URL in the **Linked resources** section of the incident issue: ```plaintext -/zoom https://example.zoom.us/j/123456789, Low on memory incident +/zoom https://example.zoom.us/j/123456789 Low on memory incident ``` ## Remove a linked resource diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index f1fb3503195..9dfac56f0ba 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # On-call Schedule Management **(PREMIUM)** diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 837fc9c72f5..55e1c9dfbcc 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Paging and notifications **(FREE)** diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index ae4d75396ae..5dd690a1c9f 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Respond -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Status Page **(ULTIMATE)** @@ -14,7 +14,7 @@ overview of recent incidents:  -Clicking an incident displays a detail page with more information about a particular incident: +Selecting an incident displays a detail page with more information about a particular incident:  @@ -140,7 +140,7 @@ you provided during setup. As part of publication, GitLab: - Publishes any files attached to incident issue descriptions, up to 5000 per issue. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205166) in GitLab 13.1.) -After publication, you can access the incident's details page by clicking the +After publication, you can access the incident's details page by selecting the **Published on status page** button displayed under the Incident's title.  |