diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-23 18:07:50 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-23 18:07:50 +0300 |
commit | 676430584d388c5c1a59eec8ab0910ded09c1995 (patch) | |
tree | 58125a10ad92344b802424de7e6c33cfc59881cb /doc/user | |
parent | 71355c5f36964482ae303c906505dc7138e2c7d7 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
19 files changed, 107 insertions, 22 deletions
diff --git a/doc/user/application_security/configuration/index.md b/doc/user/application_security/configuration/index.md index 8c34303ca00..f2fb11da66e 100644 --- a/doc/user/application_security/configuration/index.md +++ b/doc/user/application_security/configuration/index.md @@ -25,6 +25,27 @@ For each security control the page displays: - **Security Control:** Name, description, and a documentation link. - **Manage:** A management option or a documentation link. +## UI redesign + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326926) in 14.0 for GitLab Free and Premium, behind a feature flag, disabled by default. +> - Enabled on GitLab.com. +> - Recommended for production use. +> - It can be enabled or disabled for a single project. +> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-ui-redesign). **(FREE SELF)** + +WARNING: +This feature might not be available to you. Check the **version history** note above for details. + +The Security Configuration page has been redesigned in GitLab Free and Premium. +The same functionality exists as before, but presented in a more extensible +way. + +For each security control the page displays: + +- Its name, description and a documentation link. +- Whether or not it is available. +- A configuration button or a link to its configuration guide. + ## Status **(ULTIMATE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20711) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.6. @@ -52,3 +73,28 @@ You can configure the following security controls: - Secret Detection - Select **Configure via Merge Request** to create a merge request with the changes required to enable Secret Detection. For more details, see [Enable Secret Detection via an automatic merge request](../secret_detection/index.md#enable-secret-detection-via-an-automatic-merge-request). + +## Enable or disable UI redesign **(FREE SELF)** + +The Security Configuration redesign is under development, but is ready for +production use. It is deployed behind a feature flag that is **disabled by +default**. +[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) can enable it. + +To enable it: + +```ruby +# For the instance +Feature.enable(:security_configuration_redesign) +# For a single project +Feature.enable(:security_configuration_redesign, Project.find(<project id>)) +``` + +To disable it: + +```ruby +# For the instance +Feature.disable(:security_configuration_redesign) +# For a single project +Feature.disable(:security_configuration_redesign, Project.find(<project id>)) +``` diff --git a/doc/user/group/epics/manage_epics.md b/doc/user/group/epics/manage_epics.md index 89fd32a8db1..de6d49a59fc 100644 --- a/doc/user/group/epics/manage_epics.md +++ b/doc/user/group/epics/manage_epics.md @@ -5,8 +5,6 @@ group: Product Planning 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 --- -<!-- When adding a new h2 section here, remember to mention it in index.md#manage-epics --> - # Manage epics **(PREMIUM)** This page collects instructions for all the things you can do with [epics](index.md) or in relation diff --git a/doc/user/img/todos_add_todo_sidebar.png b/doc/user/img/todos_add_todo_sidebar.png Binary files differdeleted file mode 100644 index aefec7a2d9c..00000000000 --- a/doc/user/img/todos_add_todo_sidebar.png +++ /dev/null diff --git a/doc/user/img/todos_add_todo_sidebar_v14_1.png b/doc/user/img/todos_add_todo_sidebar_v14_1.png Binary files differnew file mode 100644 index 00000000000..65120beca29 --- /dev/null +++ b/doc/user/img/todos_add_todo_sidebar_v14_1.png diff --git a/doc/user/img/todos_mark_done_sidebar.png b/doc/user/img/todos_mark_done_sidebar.png Binary files differdeleted file mode 100644 index 2badd880b40..00000000000 --- a/doc/user/img/todos_mark_done_sidebar.png +++ /dev/null diff --git a/doc/user/img/todos_mark_done_sidebar_v14_1.png b/doc/user/img/todos_mark_done_sidebar_v14_1.png Binary files differnew file mode 100644 index 00000000000..628fe65a7c1 --- /dev/null +++ b/doc/user/img/todos_mark_done_sidebar_v14_1.png diff --git a/doc/user/project/description_templates.md b/doc/user/project/description_templates.md index 711d7f561e4..72ef88b5fab 100644 --- a/doc/user/project/description_templates.md +++ b/doc/user/project/description_templates.md @@ -4,7 +4,7 @@ group: Project Management 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 --- -# Description templates +# Description templates **(FREE)** We all know that a properly submitted issue is more likely to be addressed in a timely manner by the developers of a project. diff --git a/doc/user/project/import/jira.md b/doc/user/project/import/jira.md index 4273f90c1e7..07419080d7d 100644 --- a/doc/user/project/import/jira.md +++ b/doc/user/project/import/jira.md @@ -4,7 +4,7 @@ group: Project Management 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 --- -# Import your Jira project issues to GitLab +# Import your Jira project issues to GitLab **(PREMIUM)** > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2766) in GitLab 12.10. diff --git a/doc/user/project/issues/associate_zoom_meeting.md b/doc/user/project/issues/associate_zoom_meeting.md index f98e94c66ae..e020bdee737 100644 --- a/doc/user/project/issues/associate_zoom_meeting.md +++ b/doc/user/project/issues/associate_zoom_meeting.md @@ -4,7 +4,7 @@ group: Project Management 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 --- -# Associate a Zoom meeting with an issue +# Associate a Zoom meeting with an issue **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609) in GitLab 12.4. diff --git a/doc/user/project/issues/confidential_issues.md b/doc/user/project/issues/confidential_issues.md index ed15d7a2e63..92c26fb654e 100644 --- a/doc/user/project/issues/confidential_issues.md +++ b/doc/user/project/issues/confidential_issues.md @@ -4,11 +4,9 @@ group: Project Management 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 --- -# Confidential issues +# Confidential issues **(FREE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3282) in GitLab 8.6. - -Confidential issues are issues visible only to members of a project with +Confidential issues are [issues](index.md) visible only to members of a project with [sufficient permissions](#permissions-and-access-to-confidential-issues). Confidential issues can be used by open source projects and companies alike to keep security vulnerabilities private or prevent surprises from leaking out. diff --git a/doc/user/project/issues/crosslinking_issues.md b/doc/user/project/issues/crosslinking_issues.md index 63b38520c98..2b07131df6e 100644 --- a/doc/user/project/issues/crosslinking_issues.md +++ b/doc/user/project/issues/crosslinking_issues.md @@ -4,9 +4,9 @@ group: Project Management 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 --- -# Crosslinking issues +# Crosslinking issues **(FREE)** -There are several ways to mention an issue or make issues appear in each other's +There are several ways to mention an issue or make [issues](index.md) appear in each other's [Linked issues](related_issues.md) section. For more information on GitLab Issues, read the [issues documentation](index.md). diff --git a/doc/user/project/issues/issue_data_and_actions.md b/doc/user/project/issues/issue_data_and_actions.md index 13f5beadb16..1a079001af8 100644 --- a/doc/user/project/issues/issue_data_and_actions.md +++ b/doc/user/project/issues/issue_data_and_actions.md @@ -4,7 +4,7 @@ group: Project Management 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 --- -# Issue Data and Actions +# Issue Data and Actions **(FREE)** Please read through the [GitLab Issue Documentation](index.md) for an overview on GitLab Issues. diff --git a/doc/user/project/issues/managing_issues.md b/doc/user/project/issues/managing_issues.md index 35573518626..ff9360193bb 100644 --- a/doc/user/project/issues/managing_issues.md +++ b/doc/user/project/issues/managing_issues.md @@ -4,7 +4,7 @@ group: Project Management 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 --- -# Managing issues +# Managing issues **(FREE)** [GitLab Issues](index.md) are the fundamental medium for collaborating on ideas and planning work in GitLab. diff --git a/doc/user/project/merge_requests/img/status_checks_widget_passed_v14_0.png b/doc/user/project/merge_requests/img/status_checks_widget_passed_v14_0.png Binary files differnew file mode 100644 index 00000000000..de61ca8b553 --- /dev/null +++ b/doc/user/project/merge_requests/img/status_checks_widget_passed_v14_0.png diff --git a/doc/user/project/merge_requests/img/status_checks_widget_pending_v14_0.png b/doc/user/project/merge_requests/img/status_checks_widget_pending_v14_0.png Binary files differnew file mode 100644 index 00000000000..c4e606bd2f4 --- /dev/null +++ b/doc/user/project/merge_requests/img/status_checks_widget_pending_v14_0.png diff --git a/doc/user/project/merge_requests/status_checks.md b/doc/user/project/merge_requests/status_checks.md index 779e6f5c329..f0323847562 100644 --- a/doc/user/project/merge_requests/status_checks.md +++ b/doc/user/project/merge_requests/status_checks.md @@ -113,6 +113,32 @@ To complete the deletion of the status check you must select the **Remove status check** button. This **permanently** deletes the status check and it **will not** be recoverable. +## Status checks widget + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327634) in GitLab 14.1. +> - The [external status checks](#external-status-checks) feature must be [enabled](#enable-or-disable-status-checks) to see the status checks widget. + +The status checks widget displays in merge requests and shows the status of external +status checks: + +![Status checks widget](img/status_checks_widget_passed_v14_0.png) + +An organization might have a policy that does not allow merging merge requests if +external status checks do not pass. However, the details in the widget are for informational +purposes only. GitLab does not prevent merging of merge requests that fail status checks. + +While GitLab waits for a response from the external status check, the widget shows +the status checks as `pending`: + +![Status checks widget pending](img/status_checks_widget_pending_v14_0.png) + +After GitLab [receives a response](../../../api/status_checks.md#set-approval-status-of-an-external-status-check) +from the external status check, the widget updates accordingly. + +NOTE: +GitLab cannot guarantee that the external status checks are properly processed by +the related external service. + ## Troubleshooting ### Duplicate value errors @@ -149,6 +175,19 @@ An unexpected response was received from the branches retrieval API. As suggested, you should close the form and reopen again or refresh the page. This error should be temporary, although if it persists please check the [GitLab status page](https://status.gitlab.com/) to see if there is a wider outage. +### Failed to load status checks + +```plaintext +Failed to load status checks +``` + +An unexpected response was received from the external status checks API. +You should: + +- Refresh the page in case this error is temporary. +- Check the [GitLab status page](https://status.gitlab.com/) if the problem persists, + to see if there is a wider outage. + ## Enable or disable status checks **(ULTIMATE SELF)** Status checks are under development and not ready for production use. It is diff --git a/doc/user/project/merge_requests/widgets.md b/doc/user/project/merge_requests/widgets.md index 92b2a8f24ef..e4525f6a5b7 100644 --- a/doc/user/project/merge_requests/widgets.md +++ b/doc/user/project/merge_requests/widgets.md @@ -62,3 +62,9 @@ merge request widget takes you directly to the pages changed, making it easier a faster to preview proposed modifications. [Read more about Review Apps](../../../ci/review_apps/index.md). + +## External status checks **(ULTIMATE)** + +If you have configured [external status checks](status_checks.md) you can +see the status of these checks in merge requests +[in a specific widget](status_checks.md#status-checks-widget). diff --git a/doc/user/project/time_tracking.md b/doc/user/project/time_tracking.md index b7fd14ae74b..a1469c50b8e 100644 --- a/doc/user/project/time_tracking.md +++ b/doc/user/project/time_tracking.md @@ -6,9 +6,7 @@ group: Project Management 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 --- -# Time Tracking - -> Introduced in GitLab 8.14. +# Time Tracking **(FREE)** Time Tracking allows you to track estimates and time spent on issues and merge requests within GitLab. diff --git a/doc/user/todos.md b/doc/user/todos.md index 4227f46dfa8..c881925be3c 100644 --- a/doc/user/todos.md +++ b/doc/user/todos.md @@ -56,7 +56,7 @@ A to-do item appears on your To-Do List when: and you're the user that added it. When several trigger actions occur for the same user on the same object (for -example, an issue), GitLab displays only the first action as a single to do +example, an issue), GitLab displays only the first action as a single to-do item. To-do item triggers aren't affected by [GitLab notification email settings](profile/notifications.md). @@ -99,7 +99,7 @@ You can also add the following to your To-Do List by clicking the **Add a to do* - [Epics](group/epics/index.md) - [Designs](project/issues/design_management.md) -![Adding a to-do item from the issuable sidebar](img/todos_add_todo_sidebar.png) +![Adding a to-do item from the issuable sidebar](img/todos_add_todo_sidebar_v14_1.png) ## Marking a to-do item as done @@ -129,12 +129,12 @@ If no action is needed, you can manually mark the to-do item as done by clicking its corresponding **Done** button to have GitLab remove the item from your To-Do List. -![A to do in the To-Do List](img/todos_todo_list_item.png) +![A to-do in the To-Do List](img/todos_todo_list_item.png) You can also mark a to-do item as done by clicking the **Mark as done** button in the sidebar of an issue, merge request, or epic. -![Mark as done from the issuable sidebar](img/todos_mark_done_sidebar.png) +![Mark as done from the issuable sidebar](img/todos_mark_done_sidebar_v14_1.png) You can mark all your to-do items as done at once by clicking the **Mark all as done** button. @@ -147,9 +147,9 @@ You can use the following types of filters with your To-Do List: | ------- | ---------------------------------------------------------------- | | Project | Filter by project. | | Group | Filter by group. | -| Author | Filter by the author that triggered the to do. | +| Author | Filter by the author that triggered the to-do item. | | Type | Filter by issue, merge request, design, or epic. | -| Action | Filter by the action that triggered the to do. | +| Action | Filter by the action that triggered the to-do item. | You can also filter by more than one of these at the same time. The previously described [triggering actions](#what-triggers-a-to-do-item) include: |