diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-24 00:09:31 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-24 00:09:31 +0300 |
commit | 427a082f7db22d4432f491aa7ee3a18a62a20d29 (patch) | |
tree | 6527fb894f736e6b7bb2c93f6ddedee4a4795b53 /doc | |
parent | fdd0b0fd4592c74257980d07878db75705d22192 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/README.md | 1 | ||||
-rw-r--r-- | doc/api/members.md | 72 | ||||
-rw-r--r-- | doc/ci/img/metrics_reports.png | bin | 19450 -> 0 bytes | |||
-rw-r--r-- | doc/ci/img/metrics_reports_v13_0.png | bin | 0 -> 17996 bytes | |||
-rw-r--r-- | doc/ci/introduction/index.md | 5 | ||||
-rw-r--r-- | doc/ci/metrics_reports.md | 2 | ||||
-rw-r--r-- | doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v12_3.png | bin | 16435 -> 0 bytes | |||
-rw-r--r-- | doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v13_0.png | bin | 0 -> 95140 bytes | |||
-rw-r--r-- | doc/user/compliance/license_compliance/index.md | 2 | ||||
-rw-r--r-- | doc/user/project/file_lock.md | 6 | ||||
-rw-r--r-- | doc/user/project/issues/index.md | 5 | ||||
-rw-r--r-- | doc/user/project/labels.md | 19 |
12 files changed, 99 insertions, 13 deletions
diff --git a/doc/README.md b/doc/README.md index 8d4be768d2d..9ab5f7526c9 100644 --- a/doc/README.md +++ b/doc/README.md @@ -118,6 +118,7 @@ The following documentation relates to the DevOps **Plan** stage: | [Project Issue Board](user/project/issue_board.md) | Display issues on a Scrum or Kanban board. | | [Quick Actions](user/project/quick_actions.md) | Shortcuts for common actions on issues or merge requests, replacing the need to click buttons or use dropdowns in GitLab's UI. | | [Related Issues](user/project/issues/related_issues.md) **(STARTER)** | Create a relationship between issues. | +| [Requirements Management](user/project/requirements/index.md) **(ULTIMATE)** | Check your products against a set of criteria. | | [Roadmap](user/group/roadmap/index.md) **(ULTIMATE)** | Visualize epic timelines. | | [Service Desk](user/project/service_desk.md) **(PREMIUM)** | A simple way to allow people to create issues in your GitLab instance without needing their own user account. | | [Time Tracking](user/project/time_tracking.md) | Track time spent on issues and merge requests. | diff --git a/doc/api/members.md b/doc/api/members.md index e9131e2d4c3..afeda7780d7 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -282,6 +282,78 @@ Example response: } ``` +### Set override flag for a member of a group + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/4875) in GitLab 12.10. + +By default, the access level of LDAP group members is set to the value specified +by LDAP through Group Sync. You can allow access level overrides by calling this endpoint. + +```plaintext +POST /groups/:id/members/:user_id/override +``` + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `user_id` | integer | yes | The user ID of the member | + +```bash +curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override +``` + +Example response: + +```json +{ + "id": 1, + "username": "raymond_smith", + "name": "Raymond Smith", + "state": "active", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", + "access_level": 40, + "override": true +} +``` + +### Remove override for a member of a group + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/4875) in GitLab 12.10. + +Sets the override flag to false and allows LDAP Group Sync to reset the access +level to the LDAP-prescribed value. + +```plaintext +DELETE /groups/:id/members/:user_id/override +``` + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `user_id` | integer | yes | The user ID of the member | + +```bash +curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override +``` + +Example response: + +```json +{ + "id": 1, + "username": "raymond_smith", + "name": "Raymond Smith", + "state": "active", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", + "access_level": 40, + "override": false +} +``` + ## Remove a member from a group or project Removes a user from a group or project. diff --git a/doc/ci/img/metrics_reports.png b/doc/ci/img/metrics_reports.png Binary files differdeleted file mode 100644 index ffd9f6830a2..00000000000 --- a/doc/ci/img/metrics_reports.png +++ /dev/null diff --git a/doc/ci/img/metrics_reports_v13_0.png b/doc/ci/img/metrics_reports_v13_0.png Binary files differnew file mode 100644 index 00000000000..1597031db0b --- /dev/null +++ b/doc/ci/img/metrics_reports_v13_0.png diff --git a/doc/ci/introduction/index.md b/doc/ci/introduction/index.md index b16cde54b93..78317917c82 100644 --- a/doc/ci/introduction/index.md +++ b/doc/ci/introduction/index.md @@ -76,6 +76,9 @@ to apply all the continuous methods (Continuous Integration, Delivery, and Deployment) to your software with no third-party application or integration needed. +<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> +For an overview, see [Introduction to GitLab CI](https://www.youtube.com/watch?v=l5705U8s_nQ&t=397) from a recent GitLab meetup. + ### How GitLab CI/CD works To use GitLab CI/CD, all you need is an application codebase hosted in a @@ -212,7 +215,7 @@ With GitLab CI/CD you can also: To see all CI/CD features, navigate back to the [CI/CD index](../README.md). <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> -Watch the video [GitLab CI Live Demo](https://www.youtube.com/watch?v=pBe4t1CD8Fc) with a deeper overview of GitLab CI/CD. +Watch the video [GitLab CI Live Demo](https://youtu.be/l5705U8s_nQ?t=369) with a deeper overview of GitLab CI/CD. ### Setting up GitLab CI/CD for the first time diff --git a/doc/ci/metrics_reports.md b/doc/ci/metrics_reports.md index 871f8c55e83..d5c76c1f3f9 100644 --- a/doc/ci/metrics_reports.md +++ b/doc/ci/metrics_reports.md @@ -12,7 +12,7 @@ GitLab provides a lot of great reporting tools for [merge requests](../user/proj You can configure your job to use custom Metrics Reports, and GitLab will display a report on the merge request so that it's easier and faster to identify changes without having to check the entire log. -![Metrics Reports](img/metrics_reports.png) +![Metrics Reports](img/metrics_reports_v13_0.png) ## Use cases diff --git a/doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v12_3.png b/doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v12_3.png Binary files differdeleted file mode 100644 index fd519d63b3e..00000000000 --- a/doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v12_3.png +++ /dev/null diff --git a/doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v13_0.png b/doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v13_0.png Binary files differnew file mode 100644 index 00000000000..5dc46dbf979 --- /dev/null +++ b/doc/user/compliance/license_compliance/img/license_compliance_pipeline_tab_v13_0.png diff --git a/doc/user/compliance/license_compliance/index.md b/doc/user/compliance/license_compliance/index.md index f9b5a1e8d3c..22b0dfb2293 100644 --- a/doc/user/compliance/license_compliance/index.md +++ b/doc/user/compliance/license_compliance/index.md @@ -432,7 +432,7 @@ From your project's left sidebar, navigate to **CI/CD > Pipelines** and click on pipeline ID that has a `license_management` job to see the Licenses tab with the listed licenses (if any). -![License Compliance Pipeline Tab](img/license_compliance_pipeline_tab_v12_3.png) +![License Compliance Pipeline Tab](img/license_compliance_pipeline_tab_v13_0.png) <!-- ## Troubleshooting diff --git a/doc/user/project/file_lock.md b/doc/user/project/file_lock.md index d5f35051e9a..b5350515c30 100644 --- a/doc/user/project/file_lock.md +++ b/doc/user/project/file_lock.md @@ -2,9 +2,9 @@ > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/440) in [GitLab Premium](https://about.gitlab.com/pricing/) 8.9. -File Locking helps you avoid merge conflicts and better manage your binary files. -Lock any file or directory, make your changes, and then unlock it so another -member of the team can edit it. +Working with multiple people on the same file can be a risk. Conflicts when merging a non-text file are hard to overcome and will require a lot of manual work to resolve. File Locking helps you avoid these merge conflicts and better manage your binary files. + +With File Locaking, you can lock any file or directory, make your changes, and then unlock it so another member of the team can edit it. ## Overview diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index 55e9967a370..bc297d5891d 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -28,6 +28,11 @@ you can also view all the issues collectively at the group level. See also [Always start a discussion with an issue](https://about.gitlab.com/blog/2016/03/03/start-with-an-issue/). +<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> +To learn how GitLab's Strategic Marketing department uses GitLab issues with [labels](../labels.md) and +[issue boards](../issue_board.md), see the video on +[Managing Commitments with Issues](https://www.youtube.com/watch?v=cuIHNintg1o&t=3). + ## Parts of an issue Issues contain a variety of content and metadata, enabling a large range of flexibility diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md index 618ef9cfc47..f3b59147d5b 100644 --- a/doc/user/project/labels.md +++ b/doc/user/project/labels.md @@ -2,13 +2,18 @@ ## Overview -Labels allow you to categorize epics, issues, and merge requests using descriptive titles like -`bug`, `feature request`, or `docs`, as well as customizable colors. They allow you to quickly -and dynamically filter and manage epics, issues, and merge requests, and are a key -part of [issue boards](issue_board.md). - -You can use labels to help [search](../search/index.md#issues-and-merge-requests) in -lists of issues, merge requests, and epics, as well as [search in issue boards](../search/index.md#issue-boards). +As your count of issues, merge requests, and epics grows in GitLab, it's more and more challenging +to keep track of those items. Especially as your organization grows from just a few people to +hundreds or thousands. This is where labels come in. They help you organize and tag your work +so you can track and find the work items you're interested in. + +Labels are a key part of [issue boards](issue_board.md). With labels you can: + +- Categorize epics, issues, and merge requests using colors and descriptive titles like +`bug`, `feature request`, or `docs`. +- Dynamically filter and manage epics, issues, and merge requests. +- [Search lists of issues, merge requests, and epics](../search/index.md#issues-and-merge-requests), + as well as [issue boards](../search/index.md#issue-boards). ## Project labels and group labels |