diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 09:10:13 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 09:10:13 +0300 |
commit | b4610c51192adc832d25192038a781d2aa1ebb98 (patch) | |
tree | 860bb889ee850e13a1f947489d768801556f9213 /doc | |
parent | a7b6d465ae75b497ac34cb43361edd0c8ce45fbd (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
25 files changed, 128 insertions, 104 deletions
diff --git a/doc/administration/server_hooks.md b/doc/administration/server_hooks.md index a205e5a4a6f..4d262704209 100644 --- a/doc/administration/server_hooks.md +++ b/doc/administration/server_hooks.md @@ -34,6 +34,7 @@ alternatives to server hooks include: :::TabTitle GitLab 15.11 and later > [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4629) in GitLab 15.11, `hooks set` command replaces direct file system access. +> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4629) in GitLab 15.11, `hooks set` command replaces direct file system access. Existing Git hooks don't need migrating for the `hooks set` command. Prerequisites: diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index 0652b88617b..566267b97f1 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -303,7 +303,7 @@ from the server to the platform if we identify invalid parameters at the beginni If you need to add a custom validator, it would be added to it's own file in the [`validators`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/api/validations/validators) directory. Since we use [Grape](https://github.com/ruby-grape/grape) to add our API -we inherit from the `Grape::Validations::Base` class in our validator class. +we inherit from the `Grape::Validations::Validators::Base` class in our validator class. Now, all you have to do is define the `validate_param!` method which takes in two parameters: the `params` hash and the `param` name to validate. diff --git a/doc/development/contributing/index.md b/doc/development/contributing/index.md index 17e45f8c96d..eb26ddbd9e9 100644 --- a/doc/development/contributing/index.md +++ b/doc/development/contributing/index.md @@ -61,7 +61,7 @@ To write and test your code, you will use the GitLab Development Kit. - To run a pre-configured GDK instance in the cloud, use [GDK with Gitpod](../../integration/gitpod.md). From a project repository: - 1. On the top bar, select **Main menu > Projects** and find your project. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. In the upper right, select **Edit > Gitpod**. 1. If you want to contribute to the [website](https://about.gitlab.com/) or the [handbook](https://about.gitlab.com/handbook/), go to the footer of any page and select **Edit in Web IDE** to open the [Web IDE](../../user/project/web_ide/index.md). diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index 49a68a1c105..0bbd679abe5 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -525,8 +525,8 @@ Instead of: However, you can make an exception when you are writing a task and you need to refer to all of the fields at once. For example: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > CI/CD**. 1. Expand **General pipelines**. 1. Complete the fields. @@ -1249,7 +1249,7 @@ to the GitLab [reference architectures](../../../administration/reference_archit ## search -When you search, you type a string in the search box on the top bar. +When you search, you type a string in the search box on the left sidebar. The search results are displayed on a search page. Searching is different from [filtering](#filter). diff --git a/doc/development/documentation/topic_types/task.md b/doc/development/documentation/topic_types/task.md index 2ddfd841ec3..87ce4d770f5 100644 --- a/doc/development/documentation/topic_types/task.md +++ b/doc/development/documentation/topic_types/task.md @@ -43,13 +43,13 @@ Prerequisites: To create an issue: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues > List**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Plan > Issues**. 1. In the upper-right corner, select **New issue**. 1. Complete the fields. (If you have reference content that lists each field, link to it here.) 1. Select **Create issue**. -The issue is created. You can view it by going to **Issues > List**. +The issue is created. You can view it by going to **Plan > Issues**. ``` ## Task topic titles diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md index f81486d17a8..aeb9739ecb3 100644 --- a/doc/development/ee_features.md +++ b/doc/development/ee_features.md @@ -49,13 +49,16 @@ version of the product: 1. Enable **Allow use of licensed EE features** to make licensed EE features available to projects only if the project namespace's plan includes the feature. - 1. Visit **Admin > Settings > General**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. + 1. On the left sidebar, select **Settings > General**. 1. Expand **Account and limit**. 1. Select the **Allow use of licensed EE features** checkbox. 1. Select **Save changes**. 1. Ensure the group you want to test the EE feature for is actually using an EE plan: - 1. On the top bar, select **Main menu > Admin**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. 1. On the left sidebar, select **Overview > Groups**. 1. Identify the group you want to modify, and select **Edit**. 1. Scroll to **Permissions and group features**. For **Plan**, select `Ultimate`. diff --git a/doc/development/integrations/jenkins.md b/doc/development/integrations/jenkins.md index 43487486f97..65194a04a62 100644 --- a/doc/development/integrations/jenkins.md +++ b/doc/development/integrations/jenkins.md @@ -24,7 +24,8 @@ brew services start jenkins GitLab does not allow requests to localhost or the local network by default. When running Jenkins on your local machine, you need to enable local access. 1. Log into your GitLab instance as an administrator. -1. On the top bar, select **Main menu > Admin**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. 1. On the left sidebar, select **Settings > Network**. 1. Expand **Outbound requests**, and select the following checkboxes: diff --git a/doc/development/service_ping/troubleshooting.md b/doc/development/service_ping/troubleshooting.md index 57c4408ca84..2706f570869 100644 --- a/doc/development/service_ping/troubleshooting.md +++ b/doc/development/service_ping/troubleshooting.md @@ -56,9 +56,10 @@ checking the configuration file of your GitLab instance: - Using the Admin Area: - 1. On the top bar, select **Main menu > Admin**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. 1. On the left sidebar, select **Settings > Metrics and profiling**. - 1. Expand **Usage Statistics**. + 1. Expand **Usage statistics**. 1. Are you able to check or uncheck the checkbox to disable Service Ping? - If _yes_, your GitLab instance is not affected by this bug. @@ -113,9 +114,10 @@ To work around this bug, you have two options: sudo gitlab-ctl reconfigure ``` - 1. In GitLab, on the top bar, select **Main menu > Admin**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. 1. On the left sidebar, select **Settings > Metrics and profiling**. - 1. Expand **Usage Statistics**. + 1. Expand **Usage statistics**. 1. Clear the **Enable Service Ping** checkbox. 1. Select **Save Changes**. diff --git a/doc/development/snowplow/implementation.md b/doc/development/snowplow/implementation.md index 839d96929a1..2661df8afd8 100644 --- a/doc/development/snowplow/implementation.md +++ b/doc/development/snowplow/implementation.md @@ -87,7 +87,7 @@ The following example shows `data-track-*` attributes assigned to a button: | Attribute | Required | Description | |:----------------------|:---------|:------------| | `data-track-action` | true | Action the user is taking. Clicks must be prepended with `click` and activations must be prepended with `activate`. For example, focusing a form field is `activate_form_input` and clicking a button is `click_button`. Replaces `data-track-event`, which was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/290962) in GitLab 13.11. | -| `data-track-label` | false | The specific element or object to act on. This can be: the label of the element, for example, a tab labeled 'Create from template' for `create_from_template`; a unique identifier if no text is available, for example, `groups_dropdown_close` for closing the Groups dropdown list in the top bar; or the name or title attribute of a record being created. | +| `data-track-label` | false | The specific element or object to act on. This can be: the label of the element, for example, a tab labeled 'Create from template' for `create_from_template`; a unique identifier if no text is available, for example, `groups_dropdown_close` for closing the Groups dropdown list; or the name or title attribute of a record being created. | | `data-track-property` | false | Any additional property of the element, or object being acted on. | | `data-track-value` | false | Describes a numeric value (decimal) directly related to the event. This could be the value of an input. For example, `10` when clicking `internal` visibility. If omitted, this is the element's `value` property or `undefined`. For checkboxes, the default value is the element's checked attribute or `0` when unchecked. The value is parsed as numeric before sending the event. | | `data-track-extra` | false | A key-value pair object passed as a valid JSON string. This attribute is added to the `extra` property in our [`gitlab_standard`](schemas.md#gitlab_standard) schema. | @@ -421,7 +421,7 @@ Use the following arguments: |------------|---------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------| | `category` | String | | Area or aspect of the application. For example, `HealthCheckController` or `Lfs::FileTransformer`. | | `action` | String | | The action being taken. For example, a controller action such as `create`, or an Active Record callback. | -| `label` | String | `nil` | The specific element or object to act on. This can be one of the following: the label of the element, for example, a tab labeled 'Create from template' for `create_from_template`; a unique identifier if no text is available, for example, `groups_dropdown_close` for closing the Groups dropdown list in the top bar; or the name or title attribute of a record being created. | +| `label` | String | `nil` | The specific element or object to act on. This can be one of the following: the label of the element, for example, a tab labeled 'Create from template' for `create_from_template`; a unique identifier if no text is available, for example, `groups_dropdown_close` for closing the Groups dropdown list; or the name or title attribute of a record being created. | | `property` | String | `nil` | Any additional property of the element, or object being acted on. | | `value` | Numeric | `nil` | Describes a numeric value (decimal) directly related to the event. This could be the value of an input. For example, `10` when clicking `internal` visibility. | | `context` | Array\[SelfDescribingJSON\] | `nil` | An array of custom contexts to send with this event. Most events should not have any custom contexts. | diff --git a/doc/development/snowplow/index.md b/doc/development/snowplow/index.md index ca74761dbda..97a60b6f1f9 100644 --- a/doc/development/snowplow/index.md +++ b/doc/development/snowplow/index.md @@ -32,11 +32,10 @@ instances do not have a collector configured and do not collect data via Snowplo You can configure your self-managed GitLab instance to use a custom Snowplow collector. -1. On the top bar, select **Main menu > Admin**, then select **Settings > General**. - Alternatively, go to `admin/application_settings/general` in your browser. - +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. On the left sidebar, select **Settings > General**. 1. Expand **Snowplow**. - 1. Select **Enable Snowplow tracking** and enter your Snowplow configuration information. For example: | Name | Value | @@ -92,7 +91,7 @@ Each event provides attributes that describe the event. | --------- | ------- | -------- | ----------- | | category | text | true | The page or backend section of the application. Unless infeasible, use the Rails page attribute by default in the frontend, and namespace + class name on the backend, for example, `Notes::CreateService`. | | action | text | true | The action the user takes, or aspect that's being instrumented. The first word must describe the action or aspect. For example, clicks must be `click`, activations must be `activate`, creations must be `create`. Use underscores to describe what was acted on. For example, activating a form field is `activate_form_input`, an interface action like clicking on a dropdown list is `click_dropdown`, a behavior like creating a project record from the backend is `create_project`. | -| label | text | false | The specific element or object to act on. This can be one of the following: the label of the element, for example, a tab labeled 'Create from template' for `create_from_template`; a unique identifier if no text is available, for example, `groups_dropdown_close` for closing the Groups dropdown list in the top bar; or the name or title attribute of a record being created. For Service Ping metrics adapted to Snowplow events, this should be the full metric [key path](../service_ping/metrics_dictionary.md#metric-key_path) taken from its definition file. | +| label | text | false | The specific element or object to act on. This can be one of the following: the label of the element, for example, a tab labeled 'Create from template' for `create_from_template`; a unique identifier if no text is available, for example, `groups_dropdown_close` for closing the Groups dropdown list; or the name or title attribute of a record being created. For Service Ping metrics adapted to Snowplow events, this should be the full metric [key path](../service_ping/metrics_dictionary.md#metric-key_path) taken from its definition file. | | property | text | false | Any additional property of the element, or object being acted on. For Service Ping metrics adapted to Snowplow events, this should be additional information or context that can help analyze the event. For example, in the case of `usage_activity_by_stage_monthly.create.merge_requests_users`, there are four different possible merge request actions: "create", "merge", "comment", and "close". Each of these would be a possible property value. | | value | decimal | false | Describes a numeric value (decimal) directly related to the event. This could be the value of an input. For example, `10` when clicking `internal` visibility. | | context | vector | false | Additional data in the form of a [self-describing JSON](https://docs.snowplow.io/docs/pipeline-components-and-applications/iglu/common-architecture/self-describing-json-schemas/) to describe the event if the attributes are not sufficient. Each context must have its schema defined to assure data integrity. Refer to the list of GitLab-defined contexts for more details. | diff --git a/doc/development/value_stream_analytics.md b/doc/development/value_stream_analytics.md index afbd1a76a1b..e056ce9b064 100644 --- a/doc/development/value_stream_analytics.md +++ b/doc/development/value_stream_analytics.md @@ -365,7 +365,7 @@ Seed issues and merge requests for value stream analytics: Seed DORA daily metrics for value stream, insights and CI/CD analytics: -1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. On the project's homepage, in the upper-left corner, copy the **Project ID**. You need it in a later step. 1. [Create an environment for your selected project from the UI](../ci/environments/index.md#create-a-static-environment) named `production`. 1. Open the rails console: diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index 224f04ad24f..a2d50e43a80 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -172,8 +172,8 @@ To enable the Sentry integration: `event:read`, and `event:write` (for resolving events). 1. In GitLab, enable and configure Error Tracking: - 1. On the top bar, select **Main menu > Projects** and find your project. - 1. On the left sidebar, select **Monitor > Error Tracking**. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. + 1. Select **Monitor > Error Tracking**. 1. Under **Enable error tracking**, select the **Active** checkbox. 1. Under **Error tracking backend**, select **Sentry**. 1. Under **Sentry API URL**, enter your Sentry hostname. For example, diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index a3874b54ccd..edb7176c045 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -37,8 +37,8 @@ with GitLab, so it's up to developers to use a compatible client library and To create and enable a feature flag: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. Select **New feature flag**. 1. Enter a name that starts with a letter and contains only lowercase letters, digits, underscores (`_`), or dashes (`-`), and does not end with a dash (`-`) or underscore (`_`). @@ -180,8 +180,8 @@ For example: To create a user list: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. Select **View user lists** 1. Select **New user list**. 1. Enter a name for the list. @@ -196,8 +196,8 @@ When viewing a list, you can rename it by selecting **Edit** (**{pencil}**). To add users to a user list: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. Select **Edit** (**{pencil}**) next to the list you want to add users to. 1. Select **Add Users**. 1. Enter the user IDs as a comma-separated list of values. For example, @@ -210,8 +210,8 @@ To add users to a user list: To remove users from a user list: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. Select **Edit** (**{pencil}**) next to the list you want to change. 1. Select **Remove** (**{remove}**) next to the ID you want to remove. @@ -224,8 +224,8 @@ code so that you can clean it up when it's time to remove the feature flag. To search for code references of a feature flag: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. Edit the feature flag you want to remove. 1. Select **More actions** (**{ellipsis_v}**). 1. Select **Search code references**. @@ -235,8 +235,8 @@ To search for code references of a feature flag: In [GitLab 13.0 and earlier](https://gitlab.com/gitlab-org/gitlab/-/issues/8621), to disable a feature flag for a specific environment: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. For the feature flag you want to disable, select **Edit** (**{pencil}**). 1. To disable the flag: @@ -250,8 +250,8 @@ to disable a feature flag for a specific environment: To disable a feature flag for all environments: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. For the feature flag you want to disable, slide the Status toggle to **Disabled**. The feature flag is displayed on the **Disabled** tab. @@ -265,8 +265,8 @@ Then prepare your application with a client library. To get the access credentials that your application needs to communicate with GitLab: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Feature flags**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Feature flags**. 1. Select **Configure** to view the following: - **API URL**: URL where the client (application) connects to get a list of feature flags. - **Instance ID**: Unique token that authorizes the retrieval of the feature flags. diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index 74e0ed5f06a..e701fb2e5fb 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -179,8 +179,8 @@ To assign an alert: 1. Display the list of current alerts: - 1. On the top bar, select **Main menu > Projects** and find your project. - 1. On the left sidebar, select **Monitor > Alerts**. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. + 1. Select **Monitor > Alerts**. 1. Select your desired alert to display its details. @@ -219,8 +219,8 @@ Prerequisites: To configure the actions: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor**. 1. Expand the **Alerts** section, then select the **Alert settings** tab. 1. Select the **Create an incident** checkbox. 1. Optional. To customize the incident, from the **Incident template**, select a template to be diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md index 87455906b26..4360fe6243d 100644 --- a/doc/operations/incident_management/escalation_policies.md +++ b/doc/operations/incident_management/escalation_policies.md @@ -22,8 +22,8 @@ Prerequisite: To create an escalation policy: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Escalation Policies**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Escalation Policies**. 1. Select **Add an escalation policy**. 1. Enter the policy's name and description, and escalation rules to follow when a primary responder misses an alert. @@ -46,8 +46,8 @@ the paged users is created on the alert. To update an escalation policy: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Escalation Policies**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Escalation Policies**. 1. Select **Edit escalation policy** (**{pencil}**). 1. Edit the information. 1. Select **Save changes**. @@ -56,7 +56,7 @@ To update an escalation policy: To delete an escalation policy: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Escalation Policies**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Escalation Policies**. 1. Select **Delete escalation policy** (**{remove}**). 1. On the confirmation dialog, select **Delete escalation policy**. diff --git a/doc/operations/incident_management/incident_timeline_events.md b/doc/operations/incident_management/incident_timeline_events.md index d509061eca0..6a52accbfb2 100644 --- a/doc/operations/incident_management/incident_timeline_events.md +++ b/doc/operations/incident_management/incident_timeline_events.md @@ -23,8 +23,8 @@ They are grouped with dates and are listed in ascending order of the time when t To view the event timeline of an incident: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select an incident. 1. Select the **Timeline** tab. @@ -42,8 +42,8 @@ Prerequisites: To create a timeline event: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select an incident. 1. Select the **Timeline** tab. 1. Select **Add new timeline event**. @@ -66,8 +66,8 @@ Prerequisites: To create a timeline event from a comment on the incident: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select an incident. 1. Create a comment or choose an existing comment. 1. On the comment you want to add, select **Add comment to incident timeline** (**{clock}**). @@ -106,8 +106,8 @@ Prerequisites: To delete a timeline event: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select an incident. 1. Select the **Timeline** tab. 1. On the right of a timeline event, select **More actions** (**{ellipsis_v}**) and then select **Delete**. diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 5f1a2880c4b..4e2be27e424 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -154,8 +154,8 @@ Prerequisites: To configure the timer: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor**. 1. Expand the **Incidents** section, then select the **Incident settings** tab. 1. Select **Activate "time to SLA" countdown timer**. 1. Set a time limit in increments of 15 minutes. diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index 41fbe8fe83c..5fe7db71fd8 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -144,8 +144,8 @@ Prerequisites: - You must have at least the Maintainer role for the project. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor**. 1. Expand the **Alerts** section, and select **Add new integration**. 1. From the **Select integration type** dropdown list, select **Prometheus**. 1. Turn on the **Active** toggle. diff --git a/doc/operations/incident_management/linked_resources.md b/doc/operations/incident_management/linked_resources.md index 642a6972bcf..e43b08dfd78 100644 --- a/doc/operations/incident_management/linked_resources.md +++ b/doc/operations/incident_management/linked_resources.md @@ -27,8 +27,8 @@ Linked resources for an incident are listed under the **Summary** tab. To view the linked resources of an incident: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select an incident. ## Add a linked resource @@ -41,8 +41,8 @@ Prerequisites: To add a linked resource: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select an incident. 1. In the **Linked resources** section, select the plus icon (**{plus-square}**). 1. Complete the required fields. @@ -92,7 +92,7 @@ Prerequisites: To remove a linked resource: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select an incident. 1. In the **Linked resources** section, select **Remove** (**{close}**). diff --git a/doc/operations/incident_management/manage_incidents.md b/doc/operations/incident_management/manage_incidents.md index 187a398b1ee..3d2688daf6a 100644 --- a/doc/operations/incident_management/manage_incidents.md +++ b/doc/operations/incident_management/manage_incidents.md @@ -24,8 +24,8 @@ Prerequisites: To create an incident from the incidents list: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. 1. Select **Create incident**. ### From the issues list @@ -38,8 +38,8 @@ Prerequisites: To create an incident from the issues list: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues > List**, and select **New issue**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Plan > Issues**, and select **New issue**. 1. From the **Type** dropdown list, select **Incident**. Only fields relevant to incidents are available on the page. 1. Select **Create issue**. @@ -57,8 +57,8 @@ Prerequisites: To create an incident from an alert: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Alerts**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Alerts**. 1. Select your desired alert. 1. Select **Create incident**. @@ -88,8 +88,8 @@ Prerequisites: To set up a webhook with PagerDuty: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor** +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor** 1. Expand **Incidents**. 1. Select the **PagerDuty integration** tab. 1. Turn on the **Active** toggle. @@ -104,8 +104,8 @@ check if a GitLab incident is created from the incident. To view the [incidents list](incidents.md#incidents-list): -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Incidents**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Incidents**. To view an incident's [details page](incidents.md#incident-details), select it from the list. @@ -239,8 +239,8 @@ Prerequisites: To configure the setting: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor**. 1. Expand the **Incidents** section. 1. Select the **Automatically close associated incident** checkbox. 1. Select **Save changes**. diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index 9dfac56f0ba..8e3318766b4 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -28,8 +28,8 @@ Prerequisite: To create an on-call schedule: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > On-call Schedules**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > On-call Schedules**. 1. Select **Add a schedule**. 1. Enter the schedule's name and description and select a time zone. 1. Select **Add schedule**. @@ -43,8 +43,8 @@ create [rotations](#rotations) for your schedule. To update a schedule: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > On-call Schedules**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > On-call Schedules**. 1. Select **Edit schedule** (**{pencil}**). 1. Edit the information. 1. Select **Save changes**. @@ -56,8 +56,8 @@ interval (if one is set) to the corresponding times in the new time zone. To delete a schedule: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > On-call Schedules**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > On-call Schedules**. 1. Select **Delete escalation policy** (**{remove}**). 1. On the confirmation dialog, select **Delete schedule**. @@ -67,8 +67,8 @@ Add rotations to an existing schedule to put your team members on-call. To create a rotation: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > On-call Schedules**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > On-call Schedules**. 1. Select the **Add a rotation** link. 1. Enter the following information: @@ -85,8 +85,8 @@ To create a rotation: To edit a rotation: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > On-call Schedules**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > On-call Schedules**. 1. In the **Rotations** section, select **Edit rotation** (**{pencil}**). 1. Edit the information. 1. Select **Save changes**. @@ -95,8 +95,8 @@ To edit a rotation: To delete a rotation: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > On-call Schedules**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > On-call Schedules**. 1. In the **Rotations** section, select **Delete rotation** (**{remove}**). 1. On the confirmation dialog, select **Delete rotation**. diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 70c67977b73..be28e94c148 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -26,8 +26,8 @@ Email notifications are available in projects for triggered alerts. Project members with the **Owner** or **Maintainer** roles have the option to receive a single email notification for new alerts. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor**. 1. Expand **Alerts**. 1. On the **Alert settings** tab, select the **Send a single email notification to Owners and Maintainers for new alerts** checkbox. diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index fd37279806f..a159757842d 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -45,9 +45,9 @@ Prerequisite: To provide GitLab with the AWS account information needed to push content to your Status Page: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor**. -1. Expand **Status Page**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor**. +1. Expand **Status page**. 1. Select the **Active** checkbox. 1. In the **Status Page URL** box, provide the URL for your external status page. 1. In the **S3 Bucket name** box, type the name of your S3 bucket. For more information, see @@ -96,8 +96,8 @@ the issue can potentially [publish comments to your GitLab Status Page](#publish After creating the CI/CD variables, configure the Project you want to use for Incident issues: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Monitor**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Monitor**. 1. Expand **Status page**. 1. Fill in your cloud provider's credentials and make sure to select the **Active** checkbox. 1. Select **Save changes**. diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index f6033541986..544ce78fd5e 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -51,9 +51,27 @@ You can quickly see which comments involve you, because mentions for yourself (the user who is signed in) are highlighted in a different color. -Avoid mentioning `@all` in issues and merge requests. It sends an email notification -to all members of that project's parent group, not only the participants of the project. -It might be interpreted as spam. +### Mentioning all members + +> [Flag](../../administration/feature_flags.md) named `disable_all_mention` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110586) in GitLab 16.1. Disabled by default. + +FLAG: +On self-managed GitLab, by default the feature is available. +To make it unavailable, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) +named `disable_all_mention`. +On GitLab.com, this feature is available. +Disabling this feature on GitLab.com is tracked in [issue 18442](https://gitlab.com/gitlab-org/gitlab/-/issues/18442). + +When this feature flag is enabled, typing `@all` in comments and descriptions +results in plain text instead of a mention. +When you disable this feature, existing `@all` mentions in the Markdown texts are not affected +and remain as links. Only future `@all` mentions appear as plain text. + +Avoid mentioning `@all` in comments and descriptions. +When you do it, you don't only mention the participants of the project, issue, or merge request, +but to all members of that project's parent group. +All these users receive an email notification and a to-do item. It might be interpreted as spam. + Notifications and mentions can be disabled in [a group's settings](../group/manage.md#disable-email-notifications). diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 2026a033150..401fe0bcb09 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -630,7 +630,7 @@ GitLab Flavored Markdown recognizes the following: |:----------------------------------------------------------------------------|:------------------------------|:----------------------------------------|:-------------------------------| | specific user | `@user_name` | | | | specific group | `@group_name` | | | -| entire team | `@all` | | | +| entire team | [`@all`](discussions/index.md#mentioning-all-members) | | | | project | `namespace/project>` | | | | issue | ``#123`` | `namespace/project#123` | `project#123` | | merge request | `!123` | `namespace/project!123` | `project!123` | |