diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 00:09:12 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 00:09:12 +0000 |
commit | d43aaf286fe6b8e8383e73ea580274d8841608d7 (patch) | |
tree | ca03542a55583538a1ec13023dffed20457407b5 /doc/user | |
parent | 87af6f2e0590af0ed1bb3e5de1bb5d21855a94d2 (diff) | |
download | gitlab-ce-d43aaf286fe6b8e8383e73ea580274d8841608d7.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/group/epics/index.md | 46 | ||||
-rw-r--r-- | doc/user/markdown.md | 7 | ||||
-rw-r--r-- | doc/user/project/issues/design_management.md | 36 | ||||
-rw-r--r-- | doc/user/project/issues/img/issue_health_status_v12_9.png | bin | 0 -> 10509 bytes | |||
-rw-r--r-- | doc/user/project/issues/index.md | 34 | ||||
-rw-r--r-- | doc/user/project/merge_requests/code_quality.md | 12 |
6 files changed, 71 insertions, 64 deletions
diff --git a/doc/user/group/epics/index.md b/doc/user/group/epics/index.md index eae989b220b..861054c2a0a 100644 --- a/doc/user/group/epics/index.md +++ b/doc/user/group/epics/index.md @@ -23,7 +23,7 @@ graph TD Parent_epic --> Issue1 Parent_epic --> Child_epic Child_epic --> Issue2 -```` +``` ## Use cases @@ -184,6 +184,8 @@ have a [start or due date](#start-date-and-due-date), a ![Child epics roadmap](img/epic_view_roadmap_v12_9.png) +--- + ## Reordering issues and child epics > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/9367) in GitLab 12.5. @@ -240,6 +242,8 @@ You can always reopen it using the reopen button. ![reopen epic - button](img/button_reopen_epic.png) +--- + ### Using quick actions You can close or reopen an epic using [Quick actions](../../project/quick_actions.md) @@ -251,9 +255,12 @@ link in the issue sidebar. ![containing epic](img/containing_epic.png) +--- + ## Promoting an issue to an epic -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/3777) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/3777) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.6. +> - In [GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/issues/37081), it was moved to the Premium tier. If you have [permissions](../../permissions.md) to close an issue and create an epic in the parent group, you can promote an issue to an epic with the `/promote` @@ -276,10 +283,11 @@ The following issue metadata will be copied to the epic: ## Searching for an epic from epics list page -> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.5. +> - Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.5. +> - In [GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/issues/37081), it was moved to the Premium tier. You can search for an epic from the list of epics using filtered search bar (similar to -that of Issues and Merge requests) based on following parameters: +that of Issues and Merge Requests) based on following parameters: - Title or description - Author name / username @@ -287,22 +295,26 @@ that of Issues and Merge requests) based on following parameters: ![epics search](img/epics_search.png) -To search, go to the list of epics and click on the field **Search or filter results...**. +To search, go to the list of epics and click on the field **Search or filter results**. It will display a dropdown menu, from which you can add an author. You can also enter plain text to search by epic title or description. When done, press <kbd>Enter</kbd> on your keyboard to filter the list. You can also sort epics list by: -- **Created date** -- **Last updated** -- **Start date** -- **Due date** +- Created date +- Last updated +- Start date +- Due date -Each option contains a button that can toggle the order between **ascending** and **descending**. The sort option and order will be persisted to be used wherever epics are browsed including the [roadmap](../roadmap/index.md). +Each option contains a button that can toggle the order between **Ascending** and **Descending**. +The sort option and order is saved and used wherever you browse epics, including the +[Roadmap](../roadmap/index.md). ![epics sort](img/epics_sort.png) +--- + ## Permissions If you have access to view an epic and have access to view an issue already @@ -315,7 +327,7 @@ Note that for a given group, the visibility of all projects must be the same as the group, or less restrictive. That means if you have access to a group's epic, then you already have access to its projects' issues. -You may also consult the [group permissions table](../../permissions.md#group-members-permissions). +You can also consult the [group permissions table](../../permissions.md#group-members-permissions). ## Thread @@ -323,20 +335,20 @@ You may also consult the [group permissions table](../../permissions.md#group-me These text fields also fully support [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm). -## Comment, or start a thread +## Comment or start a thread -Once you wrote your comment, you can either: +Once you write your comment, you can either: -- Click "Comment" and your comment will be published. -- Click "Start thread": start a thread within that epic's discussion to discuss specific points. +- Click **Comment**, and your comment will be published. +- Click **Start thread**, and you will start a thread within that epic's discussion. ## Award emoji -- You can [award an emoji](../../award_emojis.md) to that epic or its comments. +You can [award an emoji](../../award_emojis.md) to that epic or its comments. ## Notifications -- [Receive notifications](../../profile/notifications.md) for epic events. +You can [turn on notifications](../../profile/notifications.md) to be alerted about epic events. <!-- ## Troubleshooting diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 72570848a61..29163f98fb4 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -408,7 +408,6 @@ GFM will recognize the following: | merge request | `!123` | `namespace/project!123` | `project!123` | | snippet | `$123` | `namespace/project$123` | `project$123` | | epic **(ULTIMATE)** | `&123` | `group1/subgroup&123` | | -| design **(PREMIUM)** | `#123[file.jpg]` or `#123["file.png"]` | `group1/subgroup#123[file.png]` | `project#123[file.png]` | | label by ID | `~123` | `namespace/project~123` | `project~123` | | one-word label by name | `~bug` | `namespace/project~bug` | `project~bug` | | multi-word label by name | `~"feature request"` | `namespace/project~"feature request"` | `project~"feature request"` | @@ -421,6 +420,12 @@ GFM will recognize the following: | repository file references | `[README](doc/README)` | | | | repository file line references | `[README](doc/README#L13)` | | | +In addition to this, links to some objects are also recognized and formatted. Some examples of these are: + +- Comments on issues: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234#note_101075757"`, which will be rendered as `#1234 (note1)` +- The issues designs tab: `"https://gitlab.com/gitlab-org/gitlab/issues/1234/designs"`, which will be rendered as `#1234 (designs)`. + **(PREMIUM)** + ### Task lists > If this is not rendered correctly, [view it in GitLab itself](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/user/markdown.md#task-lists). diff --git a/doc/user/project/issues/design_management.md b/doc/user/project/issues/design_management.md index ba9796dc785..add466a91b1 100644 --- a/doc/user/project/issues/design_management.md +++ b/doc/user/project/issues/design_management.md @@ -39,13 +39,6 @@ Design Management requires that projects are using If the requirements are not met, the **Designs** tab displays a message to the user. -### Feature Flags - -- Reference Parsing - - Designs support short references in Markdown, but this needs to be enabled by setting - the `:design_management_reference_filter_gfm_pipeline` feature flag. - ## Supported files Files uploaded must have a file extension of either `png`, `jpg`, `jpeg`, @@ -169,32 +162,3 @@ Different discussions have different badge numbers: From GitLab 12.5 on, new annotations will be outputted to the issue activity, so that everyone involved can participate in the discussion. - -## References - -GitLab Flavored Markdown supports references to designs. The syntax for this is: - - `#123[file.jpg]` - the issue reference, with the filename in square braces - -File names may contain a variety of odd characters, so two escaping mechanisms are supported: - -### Quoting - -File names may be quoted with double quotation marks, eg: - - `#123["file.jpg"]` - -This is useful if, for instance, your filename has square braces in its name. In this scheme, all -double quotation marks in the file name need to be escaped with backslashes, and backslashes need -to be escaped likewise: - - `#123["with with \"quote\" marks and a backslash \\.png"]` - -### Base64 Encoding - -In the case of file names that include HTML elements, you will need to escape these names to avoid -them being processed as HTML literals. To do this, we support base64 encoding, eg. - - The file `<a>.jpg` can be referenced as `#123[base64:PGE+LmpwZwo=]` - -Obviously we would advise against using such filenames. diff --git a/doc/user/project/issues/img/issue_health_status_v12_9.png b/doc/user/project/issues/img/issue_health_status_v12_9.png Binary files differnew file mode 100644 index 00000000000..f8922a74fc1 --- /dev/null +++ b/doc/user/project/issues/img/issue_health_status_v12_9.png diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index fe50ec62d2c..628228adc1b 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -50,7 +50,8 @@ must be set. </ul> <li>State</li> <ul> - <li>Status (open/closed)</li> + <li>State (open or closed)</li> + <li>Status (On track, Needs attention, or At risk)</li> <li>Confidentiality</li> <li>Tasks (completed vs. outstanding)</li> </ul> @@ -109,8 +110,7 @@ view, you can also make certain changes [in bulk](../bulk_editing.md) to the dis For more information, see the [Issue Data and Actions](issue_data_and_actions.md) page for a rundown of all the fields and information in an issue. -You can sort a list of issues several ways, including by issue creation date, milestone due date, -etc. For more information, see the [Sorting and Ordering Issue Lists](sorting_issue_lists.md) page. +You can sort a list of issues in several ways, for example by issue creation date, milestone due date. For more information, see the [Sorting and Ordering Issue Lists](sorting_issue_lists.md) page. ### Issue boards @@ -157,12 +157,38 @@ To prevent duplication of issues for the same topic, GitLab searches for similar when new issues are being created. When typing in the title in the **New Issue** page, GitLab searches titles and descriptions -across all issues the user has access to in the current project. Up 5 similar issues, +across all issues the user has access to in the current project. Up to five similar issues, sorted by most recently updated, are displayed below the title box. Note that this feature requires [GraphQL](../../../api/graphql/index.md) to be enabled. ![Similar issues](img/similar_issues.png) +--- + +### Status **(ULTIMATE)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/36427) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.9. + +To help you track the status of your issues, you can assign a status to each issue to flag work that's progressing as planned or needs attention to keep on schedule: + +- `On track` (green) +- `Needs attention` (amber) +- `At risk` (red) + +!["On track" health status on an issue](img/issue_health_status_v12_9.png) + +--- + +#### Enable issue health status + +This feature comes with the `:save_issuable_health_status` feature flag disabled by default. However, in some cases +this feature is incompatible with old configuration. To turn on the feature while configuration is +migrated, ask a GitLab administrator with Rails console access to run the following command: + +```ruby +Feature.enable(:save_issuable_health_status) +``` + ## Other Issue actions - [Create an issue from a template](../../project/description_templates.md#using-the-templates) diff --git a/doc/user/project/merge_requests/code_quality.md b/doc/user/project/merge_requests/code_quality.md index 5a8ce6a4f84..0525d17cca2 100644 --- a/doc/user/project/merge_requests/code_quality.md +++ b/doc/user/project/merge_requests/code_quality.md @@ -16,7 +16,7 @@ Code Quality: subscription. - Runs in [pipelines](../../../ci/pipelines/index.md) using a Docker image built in the [GitLab Code - Quality](https://gitlab.com/gitlab-org/security-products/codequality) project using [default Code Climate configurations](https://gitlab.com/gitlab-org/security-products/codequality/-/tree/master/codeclimate_defaults). + Quality](https://gitlab.com/gitlab-org/ci-cd/codequality) project using [default Code Climate configurations](https://gitlab.com/gitlab-org/ci-cd/codequality/-/tree/master/codeclimate_defaults). - Can make use of a [template](#example-configuration). - Is available with [Auto DevOps](../../../topics/autodevops/index.md#auto-code-quality-starter). @@ -135,14 +135,14 @@ code_quality: --env SOURCE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock - "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code + "registry.gitlab.com/gitlab-org/ci-cd/codequality:$SP_VERSION" /code artifacts: reports: codequality: gl-code-quality-report.json ``` In GitLab 12.6, Code Quality switched to the -[new versioning scheme](https://gitlab.com/gitlab-org/security-products/codequality/-/merge_requests/38). +[new versioning scheme](https://gitlab.com/gitlab-org/ci-cd/codequality#versioning-and-release-cycle). It is highly recommended to include the Code Quality template as shown in the [example configuration](#example-configuration), which uses the new versioning scheme. If not using the template, the `SP_VERSION` variable can be hardcoded to use the @@ -162,7 +162,7 @@ code_quality: --env SOURCE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock - "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code + "registry.gitlab.com/gitlab-org/ci-cd/codequality:$SP_VERSION" /code artifacts: reports: codequality: gl-code-quality-report.json @@ -184,7 +184,7 @@ code_quality: --env SOURCE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock - "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code + "registry.gitlab.com/gitlab-org/ci-cd/codequality:$SP_VERSION" /code artifacts: paths: [gl-code-quality-report.json] ``` @@ -216,7 +216,7 @@ The Code Quality job supports environment variables that users can set to configure job execution at runtime. For a list of available environment variables, see -[Environment variables](https://gitlab.com/gitlab-org/security-products/codequality/blob/master/README.md#environment-variables). +[Environment variables](https://gitlab.com/gitlab-org/ci-cd/codequality#environment-variables). ## Implementing a custom tool |