diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-02-10 18:12:42 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-02-10 18:12:42 +0300 |
commit | 74d9798736a89f07e047698e5e32964829bf8859 (patch) | |
tree | b969a2a5e29f2f83b3f7fcddfc3804f62432bbb4 /doc/user | |
parent | 190128fc72e015c383e7a96c128276d1833f3beb (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/asciidoc.md | 5 | ||||
-rw-r--r-- | doc/user/crm/index.md | 26 | ||||
-rw-r--r-- | doc/user/markdown.md | 1 | ||||
-rw-r--r-- | doc/user/project/issue_board.md | 2 | ||||
-rw-r--r-- | doc/user/project/issues/confidential_issues.md | 2 | ||||
-rw-r--r-- | doc/user/project/issues/issue_weight.md | 6 | ||||
-rw-r--r-- | doc/user/project/issues/managing_issues.md | 8 | ||||
-rw-r--r-- | doc/user/project/issues/multiple_assignees_for_issues.md | 2 | ||||
-rw-r--r-- | doc/user/project/issues/related_issues.md | 13 | ||||
-rw-r--r-- | doc/user/project/issues/sorting_issue_lists.md | 2 | ||||
-rw-r--r-- | doc/user/project/quick_actions.md | 4 | ||||
-rw-r--r-- | doc/user/shortcuts.md | 2 |
12 files changed, 52 insertions, 21 deletions
diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index da75c008ed1..80c85358fcb 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -232,6 +232,11 @@ v1.0, 2019-01-01 #### Includes +NOTE: +[Wiki pages](project/wiki/index.md#create-a-new-wiki-page) created with the AsciiDoc +format are saved with the file extension `.asciidoc`. When working with AsciiDoc wiki +pages, change the file name from `.adoc` to `.asciidoc`. + ```plaintext include::basics.adoc[] diff --git a/doc/user/crm/index.md b/doc/user/crm/index.md index f0f9a907a73..305cca33dd5 100644 --- a/doc/user/crm/index.md +++ b/doc/user/crm/index.md @@ -6,7 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Customer relations management (CRM) **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.6 [with a flag](../../administration/feature_flags.md) named `customer_relations`. Disabled by default. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.6 [with a flag](../../administration/feature_flags.md) named `customer_relations`. Disabled 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 `customer_relations`. +On GitLab.com, this feature is not available. With customer relations management (CRM) you can create a record of contacts (individuals) and organizations (companies) and relate them to issues. @@ -133,7 +137,7 @@ API. ### Add contacts to an issue -To add contacts to an issue use the `/add_contacts` +To add contacts to an issue use the `/add_contacts [contact:address@example.com]` [quick action](../project/quick_actions.md). You can also add, remove, or replace issue contacts using the @@ -142,9 +146,25 @@ API. ### Remove contacts from an issue -To remove contacts from an issue use the `/remove_contacts` +To remove contacts from an issue use the `/remove_contacts [contact:address@example.com]` [quick action](../project/quick_actions.md). You can also add, remove, or replace issue contacts using the [GraphQL](../../api/graphql/reference/index.md#mutationissuesetcrmcontacts) API. + +## Autocomplete contacts **(FREE SELF)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.8 [with a flag](../../administration/feature_flags.md) named `contacts_autocomplete`. Disabled 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 `contacts_autocomplete`. +On GitLab.com, this feature is not available. +This feature is not ready for production use. + +When you use the `/add_contacts` or `/remove_contacts` quick actions, follow them with `[contact:` and an autocomplete list appears: + +```plaintext +/add_contacts [contact: +/remove_contacts [contact: +``` diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 3d640185a55..a16f8fd39b1 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -539,6 +539,7 @@ GitLab Flavored Markdown recognizes the following: | repository file references | `[README](doc/README.md)` | | | | repository file line references | `[README](doc/README.md#L13)` | | | | [alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` | +| contact | `[contact:test@example.com]` | | | 1. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/222483) in GitLab 13.7. diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 23905133d9e..71440298d85 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -402,7 +402,7 @@ To set a WIP limit for a list: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34723) in GitLab 12.8. > - [View blocking issues when hovering over blocked icon](https://gitlab.com/gitlab-org/gitlab/-/issues/210452) in GitLab 13.10. -If an issue is blocked by another issue, an icon appears next to its title to indicate its blocked +If an issue is [blocked by another issue](issues/related_issues.md#blocking-issues), an icon appears next to its title to indicate its blocked status. When you hover over the blocked icon (**{issue-block}**), a detailed information popover is displayed. diff --git a/doc/user/project/issues/confidential_issues.md b/doc/user/project/issues/confidential_issues.md index 54fd122d742..15130523da6 100644 --- a/doc/user/project/issues/confidential_issues.md +++ b/doc/user/project/issues/confidential_issues.md @@ -51,7 +51,7 @@ the issue even if they were actively participating before the change. ## Confidential issue indicators There are a few things that visually separate a confidential issue from a -regular one. In the issues index page view, you can see the eye-slash (**(eye-slash)**) icon +regular one. In the issues index page view, you can see the eye-slash (**{eye-slash}**) icon next to the issues that are marked as confidential: ![Confidential issues index page](img/confidential_issues_index_page.png) diff --git a/doc/user/project/issues/issue_weight.md b/doc/user/project/issues/issue_weight.md index 8f17f399cb0..756fe9699f1 100644 --- a/doc/user/project/issues/issue_weight.md +++ b/doc/user/project/issues/issue_weight.md @@ -15,10 +15,8 @@ value, or complexity a given issue has or costs. You can set the weight of an issue during its creation, by changing the value in the dropdown menu. You can set it to a non-negative integer -value from 0, 1, 2, and so on. (The database stores a 4-byte value, so the -upper bound is essentially limitless.) -You can remove weight from an issue -as well. +value from 0, 1, 2, and so on. +You can remove weight from an issue as well. This value appears on the right sidebar of an individual issue, as well as in the issues page next to a weight icon (**{weight}**). diff --git a/doc/user/project/issues/managing_issues.md b/doc/user/project/issues/managing_issues.md index 39b59d5e7eb..155d6260a5c 100644 --- a/doc/user/project/issues/managing_issues.md +++ b/doc/user/project/issues/managing_issues.md @@ -319,7 +319,7 @@ You can move all open issues from one project to another. Prerequisites: -- You must have at least the Reporter role for the project. +- You must have access to the Rails console of the GitLab instance. To do it: @@ -510,9 +510,9 @@ Alternatively: ## Promote an issue to an epic **(PREMIUM)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3777) in GitLab Ultimate 11.6. -> - Moved to GitLab Premium in 12.8. -> - Promoting issues to epics via the UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233974) in GitLab Premium 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3777) in GitLab 11.6. +> - Moved from GitLab Ultimate to GitLab Premium in 12.8. +> - Promoting issues to epics via the UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233974) in GitLab 13.6. You can promote an issue to an [epic](../../group/epics/index.md) in the immediate parent group. diff --git a/doc/user/project/issues/multiple_assignees_for_issues.md b/doc/user/project/issues/multiple_assignees_for_issues.md index 98e940b6b51..f957d701a3b 100644 --- a/doc/user/project/issues/multiple_assignees_for_issues.md +++ b/doc/user/project/issues/multiple_assignees_for_issues.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Multiple Assignees for Issues **(PREMIUM)** -> - Moved to GitLab Premium in 13.9. +> Moved to GitLab Premium in 13.9. In large teams, where there is shared ownership of an issue, it can be difficult to track who is working on it, who already completed their contributions, who diff --git a/doc/user/project/issues/related_issues.md b/doc/user/project/issues/related_issues.md index f2ec58a4a69..f83ebc5e8a8 100644 --- a/doc/user/project/issues/related_issues.md +++ b/doc/user/project/issues/related_issues.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Linked issues **(FREE)** -> The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.4. +> The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) from GitLab Premium to GitLab Free in 13.4. Linked issues are a bi-directional relationship between any two issues and appear in a block below the issue description. You can link issues in different projects. @@ -33,8 +33,8 @@ To link one issue to another: select the add linked issue button (**{plus}**). 1. Select the relationship between the two issues. Either: - **relates to** - - **blocks** **(PREMIUM)** - - **is blocked by** **(PREMIUM)** + - **[blocks](#blocking-issues)** + - **[is blocked by](#blocking-issues)** 1. Input the issue number or paste in the full URL of the issue. ![Adding a related issue](img/related_issues_add_v12_8.png) @@ -69,3 +69,10 @@ Due to the bi-directional relationship, the relationship no longer appears in ei ![Removing a related issue](img/related_issues_remove_v12_8.png) Access our [permissions](../../permissions.md) page for more information. + +## Blocking issues **(PREMIUM)** + +When you [add a linked issue](#add-a-linked-issue), you can show that it **blocks** or +**is blocked by** another issue. + +Issues that block other issues have an icon (**{issue-block}**) shown in the issue lists and [boards](../issue_board.md). diff --git a/doc/user/project/issues/sorting_issue_lists.md b/doc/user/project/issues/sorting_issue_lists.md index 0340f15c25c..329f65bfacd 100644 --- a/doc/user/project/issues/sorting_issue_lists.md +++ b/doc/user/project/issues/sorting_issue_lists.md @@ -27,7 +27,7 @@ The available sorting options can change based on the context of the list. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34247/) in GitLab 13.7. When you sort by **Blocking**, the issue list changes to sort descending by the -number of issues each issue is blocking. +number of issues each issue is [blocking](related_issues.md#blocking-issues). ## Sorting by created date diff --git a/doc/user/project/quick_actions.md b/doc/user/project/quick_actions.md index 918b089bfd2..8070c37db78 100644 --- a/doc/user/project/quick_actions.md +++ b/doc/user/project/quick_actions.md @@ -49,7 +49,7 @@ threads. Some quick actions might not be available to all subscription tiers. | Command | Issue | Merge request | Epic | Action | |:-------------------------------------------------------------------------------------------------|:-----------------------|:-----------------------|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `/add_contacts email1 email2` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Add one or more [CRM contacts](../crm/index.md) ([introduced in GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73413)). | +| `/add_contacts [contact:email1@example.com] [contact:email2@example.com]` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Add one or more [CRM contacts](../crm/index.md) ([introduced in GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73413)). | | `/approve` | **{dotted-circle}** No | **{check-circle}** Yes | **{dotted-circle}** No | Approve the merge request. | | `/assign @user1 @user2` | **{check-circle}** Yes | **{check-circle}** Yes | **{dotted-circle}** No | Assign one or more users. | | `/assign me` | **{check-circle}** Yes | **{check-circle}** Yes | **{dotted-circle}** No | Assign yourself. | @@ -89,7 +89,7 @@ threads. Some quick actions might not be available to all subscription tiers. | `/relabel ~label1 ~label2` | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | Replace current labels with those specified. | | `/relate #issue1 #issue2` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Mark issues as related. | | `/remove_child_epic <epic>` | **{dotted-circle}** No | **{dotted-circle}** No | **{check-circle}** Yes | Remove child epic from `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab/-/issues/7330)). | -| `/remove_contacts email1 email2` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Remove one or more [CRM contacts](../crm/index.md) ([introduced in GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73413)). | +| `/remove_contacts [contact:email1@example.com] [contact:email2@example.com]` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Remove one or more [CRM contacts](../crm/index.md) ([introduced in GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73413)). | | `/remove_due_date` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Remove due date. | | `/remove_epic` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Remove from epic. | | `/remove_estimate` | **{check-circle}** Yes | **{check-circle}** Yes | **{dotted-circle}** No | Remove time estimate. | diff --git a/doc/user/shortcuts.md b/doc/user/shortcuts.md index d6cbbf352fc..19ab53ca969 100644 --- a/doc/user/shortcuts.md +++ b/doc/user/shortcuts.md @@ -158,7 +158,7 @@ These shortcuts are available when using a [filtered search input](search/index. | <kbd>⌘</kbd> (Mac) + <kbd>⌫</kbd> | Clear entire search filter. | | <kbd>⌥</kbd> (Mac) / <kbd>Control</kbd> + <kbd>⌫</kbd> | Clear one token at a time. | -## Epics **(ULTIMATE)** +## Epics **(PREMIUM)** These shortcuts are available when viewing [epics](group/epics/index.md): |