summaryrefslogtreecommitdiff
path: root/doc/operations
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-08-18 08:17:02 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2022-08-18 08:17:02 +0000
commitb39512ed755239198a9c294b6a45e65c05900235 (patch)
treed234a3efade1de67c46b9e5a38ce813627726aa7 /doc/operations
parentd31474cf3b17ece37939d20082b07f6657cc79a9 (diff)
downloadgitlab-ce-b39512ed755239198a9c294b6a45e65c05900235.tar.gz
Add latest changes from gitlab-org/gitlab@15-3-stable-eev15.3.0-rc42
Diffstat (limited to 'doc/operations')
-rw-r--r--doc/operations/incident_management/img/linked_resources_list_v15_3.pngbin0 -> 12838 bytes
-rw-r--r--doc/operations/incident_management/img/timeline_events_v15_1.pngbin36994 -> 18226 bytes
-rw-r--r--doc/operations/incident_management/incidents.md17
-rw-r--r--doc/operations/incident_management/linked_resources.md66
-rw-r--r--doc/operations/metrics/embed_grafana.md6
5 files changed, 82 insertions, 7 deletions
diff --git a/doc/operations/incident_management/img/linked_resources_list_v15_3.png b/doc/operations/incident_management/img/linked_resources_list_v15_3.png
new file mode 100644
index 00000000000..2a7b56391a4
--- /dev/null
+++ b/doc/operations/incident_management/img/linked_resources_list_v15_3.png
Binary files differ
diff --git a/doc/operations/incident_management/img/timeline_events_v15_1.png b/doc/operations/incident_management/img/timeline_events_v15_1.png
index 3241f35764c..67bc727bc22 100644
--- a/doc/operations/incident_management/img/timeline_events_v15_1.png
+++ b/doc/operations/incident_management/img/timeline_events_v15_1.png
Binary files differ
diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md
index f1628cb64ca..c1a4c1eb93e 100644
--- a/doc/operations/incident_management/incidents.md
+++ b/doc/operations/incident_management/incidents.md
@@ -13,7 +13,7 @@ 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
+## Incident creation
You can create an incident manually or automatically.
@@ -205,10 +205,10 @@ field populated.
### 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 on GitLab.com. Disabled on self-managed.
+> [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 not available. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `incident_timeline`.
+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.
Incident timelines are an important part of record keeping for incidents.
@@ -297,7 +297,7 @@ as a column in the Incidents List, and as a field on newly created Incidents. If
the incident isn't closed before the SLA period ends, GitLab adds a `missed::SLA`
label to the incident.
-## Incident Actions
+## Incident actions
There are different actions available to help triage and respond to incidents.
@@ -376,6 +376,15 @@ for synchronous communication during incident management. After starting a Zoom
call for an incident, you can associate the conference call with an issue. Your
team members can join the Zoom call without requesting a link.
+### Linked resources
+
+In an incident, you can [links to various resources](linked_resources.md),
+for example:
+
+- The incident Slack channel
+- Zoom meeting
+- Resources for resolving the incidents
+
### Embed metrics in incidents
You can embed metrics anywhere [GitLab Markdown](../../user/markdown.md) is
diff --git a/doc/operations/incident_management/linked_resources.md b/doc/operations/incident_management/linked_resources.md
new file mode 100644
index 00000000000..d2254a30f91
--- /dev/null
+++ b/doc/operations/incident_management/linked_resources.md
@@ -0,0 +1,66 @@
+---
+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
+---
+
+# Linked resources in incidents **(PREMIUM)**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230852) in GitLab 15.3 [with a flag](../../administration/feature_flags.md) named `incident_resource_links_widget`. Enabled on GitLab.com. Disabled on self-managed.
+
+FLAG:
+On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `incident_resource_links_widget`.
+On GitLab.com, this feature is available.
+
+To help your team members find the important links without having to search through many comments,
+you can add linked resources to an incident issue.
+
+Resources you might want link to:
+
+- Zoom meetings
+- Slack channels or threads
+- Google Docs
+
+## View linked resources of an incident
+
+Linked resources for an incident are listed under the **Summary** tab.
+
+![Linked resources list](img/linked_resources_list_v15_3.png)
+
+To view the linked resources of an incident:
+
+1. On the top bar, select **Menu > Projects** and find your project.
+1. On the left sidebar, select **Monitor > Incidents**.
+1. Select an incident.
+
+## Add a linked resource
+
+Add a linked resource manually from an incident.
+
+Prerequisites:
+
+- You must have at least the Reporter role for the project.
+
+To add a linked resource:
+
+1. On the top bar, select **Menu > Projects** and find your project.
+1. On the left sidebar, select **Monitor > Incidents**.
+1. Select an incident.
+1. In the **Linked resources** section, select the plus icon (**{plus-square}**).
+1. Complete the required fields.
+1. Select **Add**.
+
+## Remove a linked resource
+
+You can also remove a linked resource.
+
+Prerequisities:
+
+- You must have at least the Reporter role for the project.
+
+To remove a linked resource:
+
+1. On the top bar, select **Menu > Projects** and find your project.
+1. On the left sidebar, select **Monitor > Incidents**.
+1. Select an incident.
+1. In the **Linked resources** section, select **Remove** (**{close}**).
diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md
index 2229ba22be7..17ff0ff01a3 100644
--- a/doc/operations/metrics/embed_grafana.md
+++ b/doc/operations/metrics/embed_grafana.md
@@ -14,8 +14,8 @@ embed Grafana panels using either:
## Use Grafana-rendered images
-You can embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.html) panels as a
-[direct linked rendered image](https://grafana.com/docs/grafana/latest/reference/share_panel/#direct-link-rendered-image).
+You can embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.html) panels as
+[a direct link](https://grafana.com/docs/grafana/v7.5/sharing/share-panel/#use-direct-link).
Your Grafana instance must:
- Be available to the target user, either as a public dashboard or on the same network.
@@ -46,7 +46,7 @@ format. To embed panels from a Grafana instance, the data source must be:
To set up the Grafana API in Grafana:
-1. In Grafana, [generate an Admin-level API Token](https://grafana.com/docs/grafana/latest/http_api/auth/#create-api-token).
+1. In Grafana, [generate an Admin-level API Token](https://grafana.com/docs/grafana/next/developers/http_api/auth/#create-api-token).
1. In your GitLab project, go to **Settings > Monitor** and expand the **Grafana authentication**
section.
1. To enable the integration, check the **Active** checkbox.