diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-07 09:09:38 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-07 09:09:38 +0300 |
| commit | b6a92c969b16549683ef276f1db7ba9a41dc85bb (patch) | |
| tree | ccfb1fb03227e567495bdc9aa078afc57ed66f3a /doc | |
| parent | 2e26679b96b5621de70b00bc44f0d3893f1954df (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
60 files changed, 485 insertions, 204 deletions
diff --git a/doc/administration/auth/oidc.md b/doc/administration/auth/oidc.md index 76e83c8e0ad..7a808636e94 100644 --- a/doc/administration/auth/oidc.md +++ b/doc/administration/auth/oidc.md @@ -94,7 +94,7 @@ The OpenID Connect will provide you with a client details and secret for you to - `basic` - HTTP Basic Authentication - `jwt_bearer` - JWT based authentication (private key and client secret signing) - `mtls` - Mutual TLS or X.509 certificate validation - - Any other value will POST the client id and secret in the request body + - Any other value will POST the client ID and secret in the request body - If not specified, defaults to `basic`. - `<uid_field>` (optional) is the field name from the `user_info` details that will be used as `uid` value. For example, `preferred_username`. If this value is not provided or the field with the configured value is missing from the `user_info` details, the `uid` will use the `sub` field. diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index e72da1d50c5..5d114475924 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -104,11 +104,29 @@ Omnibus GitLab or install it from source: ### 2. Authentication Gitaly and GitLab use two shared secrets for authentication, one to authenticate gRPC requests -to Gitaly, and a second for authentication callbacks from Gitaly to the GitLab internal API. +to Gitaly, and a second for authentication callbacks from GitLab-Shell to the GitLab internal API. **For Omnibus GitLab** -There are two ways to configure the required tokens: +To configure the Gitaly token: + +1. On the client server, edit `/etc/gitlab/gitlab.rb`: + + ```ruby + gitlab_rails['gitaly_token'] = 'abc123secret' + ``` + +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + +1. On the Gitaly server, edit `/etc/gitlab/gitlab.rb`: + + ```ruby + gitaly['auth_token'] = 'abc123secret' + ``` + +1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + +There are two ways to configure the GitLab-Shell token: 1. Copy `/etc/gitlab/gitlab-secrets.json` from the client server to same path on the Gitaly server. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). @@ -118,7 +136,6 @@ There are two ways to configure the required tokens: 1. On the client server, edit `/etc/gitlab/gitlab.rb`: ```ruby - gitlab_rails['gitaly_token'] = 'abc123secret' gitlab_shell['secret_token'] = 'shellsecret' ``` @@ -127,7 +144,6 @@ There are two ways to configure the required tokens: 1. On the Gitaly server, edit `/etc/gitlab/gitlab.rb`: ```ruby - gitaly['auth_token'] = 'abc123secret' gitlab_shell['secret_token'] = 'shellsecret' ``` diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md index 71428da90ab..76655a945a3 100644 --- a/doc/administration/integration/plantuml.md +++ b/doc/administration/integration/plantuml.md @@ -169,10 +169,10 @@ diagram delimiters `@startuml`/`@enduml` as these are replaced by the AsciiDoc ` Some parameters can be added to the AsciiDoc block definition: -- *format*: Can be either `png` or `svg`. Note that `svg` is not supported by +- `format`: Can be either `png` or `svg`. Note that `svg` is not supported by all browsers so use with care. The default is `png`. -- *id*: A CSS id added to the diagram HTML tag. -- *width*: Width attribute added to the image tag. -- *height*: Height attribute added to the image tag. +- `id`: A CSS ID added to the diagram HTML tag. +- `width`: Width attribute added to the image tag. +- `height`: Height attribute added to the image tag. Markdown does not support any parameters and will always use PNG format. diff --git a/doc/administration/monitoring/prometheus/gitlab_metrics.md b/doc/administration/monitoring/prometheus/gitlab_metrics.md index ef1d9d95ffa..9391971fd3e 100644 --- a/doc/administration/monitoring/prometheus/gitlab_metrics.md +++ b/doc/administration/monitoring/prometheus/gitlab_metrics.md @@ -78,7 +78,7 @@ The following metrics are available: | `gitlab_transaction_event_remove_tag_total` | Counter | 9.4 | Counter when a tag is remove for any repository | | | `gitlab_transaction_event_sidekiq_exception_total` | Counter | 9.4 | Counter of Sidekiq exceptions | | | `gitlab_transaction_event_stuck_import_jobs_total` | Counter | 9.4 | Count of stuck import jobs | `projects_without_jid_count`, `projects_with_jid_count` | -| `gitlab_transaction_event_update_build_total` | Counter | 9.4 | Counter for update build for API /jobs/request/:id | | +| `gitlab_transaction_event_update_build_total` | Counter | 9.4 | Counter for update build for API `/jobs/request/:id` | | | `gitlab_transaction_new_redis_connections_total` | Counter | 9.4 | Counter for new Redis connections | | | `gitlab_transaction_queue_duration_total` | Counter | 9.4 | Duration jobs were enqueued before processing | | | `gitlab_transaction_rails_queue_duration_total` | Counter | 9.4 | Measures latency between GitLab Workhorse forwarding a request to Rails | `controller`, `action` | diff --git a/doc/administration/operations/ssh_certificates.md b/doc/administration/operations/ssh_certificates.md index eaf0e4ab284..b652f282b7b 100644 --- a/doc/administration/operations/ssh_certificates.md +++ b/doc/administration/operations/ssh_certificates.md @@ -50,7 +50,7 @@ the GitLab server itself, but your setup may vary. If the CA is only used for GitLab consider putting this in the `Match User git` section (described below). -The SSH certificates being issued by that CA **MUST** have a "key id" +The SSH certificates being issued by that CA **MUST** have a "key ID" corresponding to that user's username on GitLab, e.g. (some output omitted for brevity): @@ -77,7 +77,7 @@ own `AuthorizedPrincipalsCommand` to do that mapping instead of using our provided default. The important part is that the `AuthorizedPrincipalsCommand` must be -able to map from the "key id" to a GitLab username in some way, the +able to map from the "key ID" to a GitLab username in some way, the default command we ship assumes there's a 1=1 mapping between the two, since the whole point of this is to allow us to extract a GitLab username from the key itself, instead of relying on something like the @@ -122,7 +122,7 @@ into multiple lines of `authorized_keys` output, as described in the Normally when using the `AuthorizedKeysCommand` with OpenSSH the principal is some "group" that's allowed to log into that server. However with GitLab it's only used to appease OpenSSH's -requirement for it, we effectively only care about the "key id" being +requirement for it, we effectively only care about the "key ID" being correct. Once that's extracted GitLab will enforce its own ACLs for that user (e.g. what projects the user can access). diff --git a/doc/administration/repository_storage_types.md b/doc/administration/repository_storage_types.md index 1281131fab1..e285e938bfc 100644 --- a/doc/administration/repository_storage_types.md +++ b/doc/administration/repository_storage_types.md @@ -124,7 +124,7 @@ GitLab server. For example, on a default Omnibus installation this would be `/var/opt/gitlab/git-data/repositories/@hashed/b1/7e/b17ef6d19c7a5b1ee83b907c595526dcb1eb06db8227d650d5dda0a9f4ce8cd9.git` with `.git` from the end of the directory name removed. -The output includes the project id and the project name: +The output includes the project ID and the project name: ```plaintext => #<Project id:16 it/supportteam/ticketsystem> diff --git a/doc/administration/troubleshooting/sidekiq.md b/doc/administration/troubleshooting/sidekiq.md index 31e41725834..ca21c038267 100644 --- a/doc/administration/troubleshooting/sidekiq.md +++ b/doc/administration/troubleshooting/sidekiq.md @@ -282,7 +282,8 @@ Commonly, `<condition>` references the job arguments, which depend on the type o For example, `repository_import` has `project_id` as the job argument, while `update_merge_requests` has `project_id, user_id, oldrev, newrev, ref`. -NOTE: **Note:** Arguments need to be referenced by their sequence id using `job.args[<id>]` because `job.args` is a list of all arguments provided to the Sidekiq job. +NOTE: **Note:** +Arguments need to be referenced by their sequence ID using `job.args[<id>]` because `job.args` is a list of all arguments provided to the Sidekiq job. Here are some examples: diff --git a/doc/api/README.md b/doc/api/README.md index 76bb3506f38..7b287d258f5 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -446,9 +446,9 @@ For example: DELETE /projects/:id/share/:group_id ``` -The `:id` path parameter needs to be replaced with the project id, and the `:group_id` needs to be replaced with the id of the group. The colons `:` should not be included. +The `:id` path parameter needs to be replaced with the project ID, and the `:group_id` needs to be replaced with the ID of the group. The colons `:` should not be included. -The resulting cURL call for a project with id `5` and a group id of `17` is then: +The resulting cURL call for a project with ID `5` and a group ID of `17` is then: ```shell curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/share/17 diff --git a/doc/api/applications.md b/doc/api/applications.md index c7bfebb75fa..eb0d130fd3c 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -93,7 +93,7 @@ Parameters: | Attribute | Type | Required | Description | |:----------|:--------|:---------|:----------------------------------------------------| -| `id` | integer | yes | The id of the application (not the application_id). | +| `id` | integer | yes | The ID of the application (not the application_id). | Example request: diff --git a/doc/api/commits.md b/doc/api/commits.md index ec25f3a41ac..87fb60a7573 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -94,7 +94,7 @@ POST /projects/:id/repository/commits | `previous_path` | string | no | Original full path to the file being moved. Ex. `lib/class1.rb`. Only considered for `move` action. | | `content` | string | no | File content, required for all except `delete`, `chmod`, and `move`. Move actions that do not specify `content` will preserve the existing file content, and any other value of `content` will overwrite the file content. | | `encoding` | string | no | `text` or `base64`. `text` is default. | -| `last_commit_id` | string | no | Last known file commit id. Will be only considered in update, move and delete actions. | +| `last_commit_id` | string | no | Last known file commit ID. Will be only considered in update, move, and delete actions. | | `execute_filemode` | boolean | no | When `true/false` enables/disables the execute flag on the file. Only considered for `chmod` action. | ```shell diff --git a/doc/api/epics.md b/doc/api/epics.md index 7cdf6c2729b..0cffc1bee85 100644 --- a/doc/api/epics.md +++ b/doc/api/epics.md @@ -249,7 +249,7 @@ POST /groups/:id/epics | `start_date_fixed` | string | no | The fixed start date of an epic (since 11.3) | | `due_date_is_fixed` | boolean | no | Whether due date should be sourced from `due_date_fixed` or from milestones (since 11.3) | | `due_date_fixed` | string | no | The fixed due date of an epic (since 11.3) | -| `parent_id` | integer/string | no | The id of a parent epic (since 11.11) | +| `parent_id` | integer/string | no | The ID of a parent epic (since 11.11) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics?title=Epic&description=Epic%20description diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index baf257eb2ff..c483743a303 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -249,6 +249,101 @@ type AlertManagementAlertEdge { } """ +Values for sorting alerts +""" +enum AlertManagementAlertSort { + """ + Created time by ascending order + """ + CREATED_TIME_ASC + + """ + Created time by ascending order + """ + CREATED_TIME_DESC + + """ + End time by ascending order + """ + END_TIME_ASC + + """ + End time by descending order + """ + END_TIME_DESC + + """ + Events count by ascending order + """ + EVENTS_COUNT_ASC + + """ + Events count by descending order + """ + EVENTS_COUNT_DESC + + """ + Severity by ascending order + """ + SEVERITY_ASC + + """ + Severity by descending order + """ + SEVERITY_DESC + + """ + Start time by ascending order + """ + START_TIME_ASC + + """ + Start time by descending order + """ + START_TIME_DESC + + """ + Status by ascending order + """ + STATUS_ASC + + """ + Status by descending order + """ + STATUS_DESC + + """ + Created time by ascending order + """ + UPDATED_TIME_ASC + + """ + Created time by ascending order + """ + UPDATED_TIME_DESC + + """ + Created at ascending order + """ + created_asc + + """ + Created at descending order + """ + created_desc + + """ + Updated at ascending order + """ + updated_asc + + """ + Updated at descending order + """ + updated_desc +} + +""" Alert severity values """ enum AlertManagementSeverity { @@ -6705,6 +6800,11 @@ type Project { IID of the alert. For example, "1" """ iid: String + + """ + Sort alerts by this criteria + """ + sort: AlertManagementAlertSort ): AlertManagementAlert """ @@ -6735,6 +6835,11 @@ type Project { Returns the last _n_ elements from the list. """ last: Int + + """ + Sort alerts by this criteria + """ + sort: AlertManagementAlertSort ): AlertManagementAlertConnection """ diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 83809db6a9b..661a7cec50c 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -724,6 +724,125 @@ }, { "kind": "ENUM", + "name": "AlertManagementAlertSort", + "description": "Values for sorting alerts", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "updated_desc", + "description": "Updated at descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_asc", + "description": "Updated at ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_desc", + "description": "Created at descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_asc", + "description": "Created at ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "START_TIME_ASC", + "description": "Start time by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "START_TIME_DESC", + "description": "Start time by descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "END_TIME_ASC", + "description": "End time by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "END_TIME_DESC", + "description": "End time by descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_TIME_ASC", + "description": "Created time by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_TIME_DESC", + "description": "Created time by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_TIME_ASC", + "description": "Created time by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_TIME_DESC", + "description": "Created time by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EVENTS_COUNT_ASC", + "description": "Events count by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EVENTS_COUNT_DESC", + "description": "Events count by descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEVERITY_ASC", + "description": "Severity by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEVERITY_DESC", + "description": "Severity by descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STATUS_ASC", + "description": "Status by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STATUS_DESC", + "description": "Status by descending order", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", "name": "AlertManagementSeverity", "description": "Alert severity values", "fields": null, @@ -20262,6 +20381,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "sort", + "description": "Sort alerts by this criteria", + "type": { + "kind": "ENUM", + "name": "AlertManagementAlertSort", + "ofType": null + }, + "defaultValue": null } ], "type": { @@ -20287,6 +20416,16 @@ "defaultValue": null }, { + "name": "sort", + "description": "Sort alerts by this criteria", + "type": { + "kind": "ENUM", + "name": "AlertManagementAlertSort", + "ofType": null + }, + "defaultValue": null + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index 6d5961a7eb8..5b7164cdd4d 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -7,7 +7,7 @@ Badges support placeholders that will be replaced in real time in both the link and image URL. The allowed placeholders are: - **%{project_path}**: will be replaced by the project path. -- **%{project_id}**: will be replaced by the project id. +- **%{project_id}**: will be replaced by the project ID. - **%{default_branch}**: will be replaced by the project default branch. - **%{commit_sha}**: will be replaced by the last project's commit SHA. diff --git a/doc/api/jobs.md b/doc/api/jobs.md index 0d16b99e241..c06dc56407c 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -543,8 +543,8 @@ GET /projects/:id/jobs/:job_id/trace | Attribute | Type | Required | Description | |-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------| -| id | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| job_id | integer | yes | ID of a job. | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `job_id` | integer | yes | ID of a job. | ```shell curl --location --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/jobs/8/trace" diff --git a/doc/api/managed_licenses.md b/doc/api/managed_licenses.md index 66125d23a82..13eb3a3fea7 100644 --- a/doc/api/managed_licenses.md +++ b/doc/api/managed_licenses.md @@ -90,7 +90,7 @@ Example response: ## Delete a managed license -Deletes a managed license with a given id. +Deletes a managed license with a given ID. ```plaintext DELETE /projects/:id/managed_licenses/:managed_license_id diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index df87c18849b..86c558c582c 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -972,7 +972,7 @@ POST /projects/:id/merge_requests | `assignee_id` | integer | no | Assignee user ID | | `assignee_ids` | integer array | no | The ID of the user(s) to assign the MR to. Set to `0` or provide an empty value to unassign all assignees. | | `description` | string | no | Description of MR. Limited to 1,048,576 characters. | -| `target_project_id` | integer | no | The target project (numeric id) | +| `target_project_id` | integer | no | The target project (numeric ID) | | `labels` | string | no | Labels for MR as a comma-separated list | | `milestone_id` | integer | no | The global ID of a milestone | | `remove_source_branch` | boolean | no | Flag indicating if a merge request should remove the source branch when merging | diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md index 859e88d0945..3a79268e889 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -54,7 +54,7 @@ GET /projects/:id/pipeline_schedules/:pipeline_schedule_id | Attribute | Type | required | Description | |--------------|---------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | ```shell curl --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13" @@ -150,7 +150,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id | Attribute | Type | required | Description | |---------------|---------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | | `description` | string | no | The description of pipeline schedule | | `ref` | string | no | The branch/tag name will be triggered | | `cron` | string | no | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) | @@ -200,7 +200,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/take_ownership | Attribute | Type | required | Description | |---------------|---------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | ```shell curl --request POST --header "PRIVATE-TOKEN: hf2CvZXB9w8Uc5pZKpSB" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/take_ownership" @@ -245,7 +245,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id | Attribute | Type | required | Description | |----------------|---------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | ```shell curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13" @@ -293,7 +293,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/play | Attribute | Type | required | Description | | ---------------- | --------- | ---------- | -------------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | Example request: @@ -324,7 +324,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables | Attribute | Type | required | Description | |------------------------|----------------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | | `key` | string | yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed | | `value` | string | yes | The `value` of a variable | | `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | @@ -352,7 +352,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key | Attribute | Type | required | Description | |------------------------|----------------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | | `key` | string | yes | The `key` of a variable | | `value` | string | yes | The `value` of a variable | | `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | @@ -380,7 +380,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key | Attribute | Type | required | Description | |------------------------|----------------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | +| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | | `key` | string | yes | The `key` of a variable | ```shell diff --git a/doc/api/pipeline_triggers.md b/doc/api/pipeline_triggers.md index 55c6e37c164..1a63a04be71 100644 --- a/doc/api/pipeline_triggers.md +++ b/doc/api/pipeline_triggers.md @@ -43,7 +43,7 @@ GET /projects/:id/triggers/:trigger_id | Attribute | Type | required | Description | |--------------|---------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `trigger_id` | integer | yes | The trigger id | +| `trigger_id` | integer | yes | The trigger ID | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/triggers/5" @@ -101,7 +101,7 @@ PUT /projects/:id/triggers/:trigger_id | Attribute | Type | required | Description | |---------------|---------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `trigger_id` | integer | yes | The trigger id | +| `trigger_id` | integer | yes | The trigger ID | | `description` | string | no | The trigger name | ```shell @@ -131,7 +131,7 @@ DELETE /projects/:id/triggers/:trigger_id | Attribute | Type | required | Description | |----------------|---------|----------|--------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `trigger_id` | integer | yes | The trigger id | +| `trigger_id` | integer | yes | The trigger ID | ```shell curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/triggers/5" diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 4afb898eb91..4adeb50deca 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -7,7 +7,7 @@ Badges support placeholders that will be replaced in real time in both the link and image URL. The allowed placeholders are: - **%{project_path}**: will be replaced by the project path. -- **%{project_id}**: will be replaced by the project id. +- **%{project_id}**: will be replaced by the project ID. - **%{default_branch}**: will be replaced by the project default branch. - **%{commit_sha}**: will be replaced by the last project's commit sha. diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index f4fb2dfd05f..f380ba5a1b2 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -55,7 +55,7 @@ GET /projects/:id/releases/:tag_name/assets/links/:link_id | ------------- | -------------- | -------- | --------------------------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). | | `tag_name` | string | yes | The tag associated with the Release. | -| `link_id` | integer | yes | The id of the link. | +| `link_id` | integer | yes | The ID of the link. | Example request: @@ -122,7 +122,7 @@ PUT /projects/:id/releases/:tag_name/assets/links/:link_id | ------------- | -------------- | -------- | --------------------------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). | | `tag_name` | string | yes | The tag associated with the Release. | -| `link_id` | integer | yes | The id of the link. | +| `link_id` | integer | yes | The ID of the link. | | `name` | string | no | The name of the link. | | `url` | string | no | The URL of the link. | @@ -158,7 +158,7 @@ DELETE /projects/:id/releases/:tag_name/assets/links/:link_id | ------------- | -------------- | -------- | --------------------------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). | | `tag_name` | string | yes | The tag associated with the Release. | -| `link_id` | integer | yes | The id of the link. | +| `link_id` | integer | yes | The ID of the link. | Example request: diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 746d982e16d..62a87b658a9 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -236,7 +236,7 @@ Parameters: - `author_name` (optional) - Specify the commit author's name - `content` (required) - New file content - `commit_message` (required) - Commit message -- `last_commit_id` (optional) - Last known file commit id +- `last_commit_id` (optional) - Last known file commit ID If the commit fails for any reason we return a 400 error with a non-specific error message. Possible causes for a failed commit include: @@ -271,4 +271,4 @@ Parameters: - `author_email` (optional) - Specify the commit author's email address - `author_name` (optional) - Specify the commit author's name - `commit_message` (required) - Commit message -- `last_commit_id` (optional) - Last known file commit id +- `last_commit_id` (optional) - Last known file commit ID diff --git a/doc/api/scim.md b/doc/api/scim.md index eaa56b0d0dd..c0650b8a0aa 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -158,13 +158,13 @@ Returns a `201` status code if successful. Fields that can be updated are: -| SCIM/IdP field | GitLab field | -|:----------|:--------| -| id/externalId | extern_uid | -| name.formatted | name | -| emails\[type eq "work"\].value | email | -| active | Identity removal if `active = false` | -| userName | username | +| SCIM/IdP field | GitLab field | +|:---------------------------------|:---------------------------------------| +| `id/externalId` | `extern_uid` | +| `name.formatted` | `name` | +| `emails\[type eq "work"\].value` | `email` | +| `active` | Identity removal if `active` = `false` | +| `userName` | `username` | ```text PATCH /api/scim/v2/groups/:group_path/Users/:id diff --git a/doc/api/settings.md b/doc/api/settings.md index d86965d2817..f8749940cdd 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -331,13 +331,13 @@ are listed in the descriptions of the relevant settings. | `sign_in_text` | string | no | Text on the login page. | | `signup_enabled` | boolean | no | Enable registration. Default is `true`. | | `slack_app_enabled` | boolean | no | **(PREMIUM)** (**If enabled, requires:** `slack_app_id`, `slack_app_secret` and `slack_app_secret`) Enable Slack app. | -| `slack_app_id` | string | required by: `slack_app_enabled` | **(PREMIUM)** The app id of the Slack-app. | +| `slack_app_id` | string | required by: `slack_app_enabled` | **(PREMIUM)** The app ID of the Slack-app. | | `slack_app_secret` | string | required by: `slack_app_enabled` | **(PREMIUM)** The app secret of the Slack-app. | | `slack_app_verification_token` | string | required by: `slack_app_enabled` | **(PREMIUM)** The verification token of the Slack-app. | | `snowplow_collector_hostname` | string | required by: `snowplow_enabled` | The Snowplow collector hostname. (for example, `snowplow.trx.gitlab.net`) | | `snowplow_cookie_domain` | string | no | The Snowplow cookie domain. (for example, `.gitlab.com`) | | `snowplow_enabled` | boolean | no | Enable snowplow tracking. | -| `snowplow_app_id` | string | no | The Snowplow site name / application id. (for example, `gitlab`) | +| `snowplow_app_id` | string | no | The Snowplow site name / application ID. (for example, `gitlab`) | | `snowplow_iglu_registry_url` | string | no | The Snowplow base Iglu Schema Registry URL to use for custom context and self describing events'| | `sourcegraph_enabled` | boolean | no | Enables Sourcegraph integration. Default is `false`. **If enabled, requires** `sourcegraph_url`. | | `sourcegraph_url` | string | required by: `sourcegraph_enabled` | The Sourcegraph instance URL for integration. | diff --git a/doc/api/users.md b/doc/api/users.md index 90aafcef035..ac2123c98e9 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -611,7 +611,7 @@ GET /users/:id_or_username/status | Attribute | Type | Required | Description | | ---------------- | ------ | -------- | ----------- | -| `id_or_username` | string | yes | The id or username of the user to get a status of | +| `id_or_username` | string | yes | The ID or username of the user to get a status of | ```shell curl "https://gitlab.example.com/users/janedoe/status" @@ -723,7 +723,7 @@ GET /users/:id_or_username/keys | Attribute | Type | Required | Description | | ---------------- | ------ | -------- | ----------- | -| `id_or_username` | string | yes | The id or username of the user to get the SSH keys for. | +| `id_or_username` | string | yes | The ID or username of the user to get the SSH keys for. | ## Single SSH key @@ -794,7 +794,7 @@ POST /users/:id/keys Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `title` (required) - new SSH Key's title - `key` (required) - new SSH key @@ -821,7 +821,7 @@ DELETE /users/:id/keys/:key_id Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `key_id` (required) - SSH key ID ## List all GPG keys @@ -1070,7 +1070,7 @@ GET /users/:id/emails Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user ## Single email @@ -1133,7 +1133,7 @@ POST /users/:id/emails Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `email` (required) - email address - `skip_confirmation` (optional) - Skip confirmation and assume e-mail is verified - true or false (default) @@ -1160,7 +1160,7 @@ DELETE /users/:id/emails/:email_id Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `email_id` (required) - email ID ## Block user @@ -1173,7 +1173,7 @@ POST /users/:id/block Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Returns: @@ -1191,7 +1191,7 @@ POST /users/:id/unblock Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Will return `201 OK` on success, `404 User Not Found` is user cannot be found or `403 Forbidden` when trying to unblock a user blocked by LDAP synchronization. @@ -1208,7 +1208,7 @@ POST /users/:id/deactivate Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Returns: @@ -1230,7 +1230,7 @@ POST /users/:id/activate Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Returns: diff --git a/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md b/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md index 848808f65ea..d65f925bf2e 100644 --- a/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md +++ b/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md @@ -417,7 +417,7 @@ credentials, which will be the same two credentials (Key ID and Secret). It's a fully understand [IAM Best Practices in AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html). We need to add these credentials to GitLab: 1. Log into your AWS account and go to the [Security Credentials page](https://console.aws.amazon.com/iam/home#/security_credential) -1. Click the **Access Keys** section and **Create New Access Key**. Create the key and keep the id and secret around, you'll need them later +1. Click the **Access Keys** section and **Create New Access Key**. Create the key and keep the ID and secret around, you'll need them later  @@ -426,7 +426,7 @@ fully understand [IAM Best Practices in AWS](https://docs.aws.amazon.com/IAM/lat  -1. Add a key named `AWS_KEY_ID` and copy the key id from Step 2 into the **Value** textbox +1. Add a key named `AWS_KEY_ID` and copy the key ID from Step 2 into the **Value** textbox 1. Add a key named `AWS_KEY_SECRET` and copy the key secret from Step 2 into the **Value** textbox ### Deploy your game with GitLab CI/CD diff --git a/doc/ci/merge_request_pipelines/index.md b/doc/ci/merge_request_pipelines/index.md index 6886e1bc3af..9e9d4ee403b 100644 --- a/doc/ci/merge_request_pipelines/index.md +++ b/doc/ci/merge_request_pipelines/index.md @@ -13,17 +13,27 @@ changes are pushed to a branch. If you want the pipeline to run jobs **only** when merge requests are created or updated, you can use *pipelines for merge requests*. -In the UI, these pipelines are labeled as `detached`. +In the UI, these pipelines are labeled as `detached`. Otherwise, these pipelines appear the same +as other pipelines. + +Any user who has developer [permissions](../../user/permissions.md) +can run a pipeline for merge requests.  -A few notes: +NOTE: **Note**: +If you use this feature with [merge when pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md), +pipelines for merge requests take precedence over the other regular pipelines. + +## Prerequisites + +To enable pipelines for merge requests: -- Pipelines for merge requests are incompatible with - [CI/CD for external repositories](../ci_cd_for_external_repos/index.md). -- [Since GitLab 11.10](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25504), pipelines for merge requests require GitLab Runner 11.9. -- If you use this feature with [merge when pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md), - pipelines for merge requests take precedence over the other regular pipelines. +- You must have maintainer [permissions](../../user/permissions.md). +- Your repository must be a GitLab repository, not an + [external repository](../ci_cd_for_external_repos/index.md). +- [In GitLab 11.10 and later](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25504), + you must be using GitLab Runner 11.9. ## Configuring pipelines for merge requests diff --git a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md index 4ca223204d5..c35a5d0a07e 100644 --- a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md +++ b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md @@ -34,14 +34,18 @@ In these cases, the pipeline runs as a [pipeline for merge requests](../index.md and is labeled as `detached`. If these cases no longer exist, new pipelines will again run against the merged results. -## Requirements and limitations +Any user who has developer [permissions](../../../user/permissions.md) can run a +pipeline for merged results. -Pipelines for merged results have the following requirements and limitations: +## Prerequisites -- Pipelines for merged results require [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) 11.9 or newer. -- Forking/cross-repo workflows are not currently supported. To follow progress, +To enable pipelines for merge results: + +- You must have maintainer [permissions](../../../user/permissions.md). +- You must be using [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) 11.9 or later. +- You must not be forking or using cross-repo workflows. To follow progress, see [#11934](https://gitlab.com/gitlab-org/gitlab/issues/11934). -- This feature is not available for +- You must not be using [fast forward merges](../../../user/project/merge_requests/fast_forward_merge.md) yet. To follow progress, see [#58226](https://gitlab.com/gitlab-org/gitlab/-/issues/26996). diff --git a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md index 641192afea1..d921b75aa44 100644 --- a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md +++ b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md @@ -30,6 +30,14 @@ If the pipeline for the merge request at the front of the train completes succes the changes are merged into the target branch, and the other pipelines continue to run. +To add a merge request to a merge train, you need [permissions](../../../../user/permissions.md) to push to the target branch. + +NOTE: **Note:** +Each merge train can run a maximum of **twenty** pipelines in parallel. +If more than twenty merge requests are added to the merge train, the merge requests +will be queued until a slot in the merge train is free. There is no limit to the +number of merge requests that can be queued. + ## Merge train example Three merge requests (`A`, `B` and `C`) are added to a merge train in order, which @@ -55,16 +63,13 @@ Watch this video for a demonstration on [how parallel execution of Merge Trains can prevent commits from breaking the default branch](https://www.youtube.com/watch?v=D4qCqXgZkHQ). -## Requirements and limitations +## Prerequisites -Merge trains have the following requirements and limitations: +To enable merge trains: -- Merge trains require [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) 11.9 or newer. -- GitLab 12.0 and later requires [Redis](https://redis.io/) 3.2 or higher. -- Each merge train can run a maximum of **twenty** pipelines in parallel. - If more than twenty merge requests are added to the merge train, the merge requests - will be queued until a slot in the merge train is free. There is no limit to the - number of merge requests that can be queued. +- You must have maintainer [permissions](../../../../user/permissions.md). +- You must be using [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) 11.9 or later. +- In GitLab 12.0 and later, you need [Redis](https://redis.io/) 3.2 or later. ## Enable merge trains diff --git a/doc/ci/variables/predefined_variables.md b/doc/ci/variables/predefined_variables.md index f53fd371c10..a0754e94703 100644 --- a/doc/ci/variables/predefined_variables.md +++ b/doc/ci/variables/predefined_variables.md @@ -56,7 +56,7 @@ future GitLab releases.** | `CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA` | 12.3 | all | The HEAD SHA of the source branch of the pull request if [the pipelines are for external pull requests](../ci_cd_for_external_repos/index.md#pipelines-for-external-pull-requests). Available only if `only: [external_pull_requests]` or [`rules`](../yaml/README.md#rules) syntax is used and the pull request is open. | | `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME` | 12.3 | all | The target branch name of the pull request if [the pipelines are for external pull requests](../ci_cd_for_external_repos/index.md#pipelines-for-external-pull-requests). Available only if `only: [external_pull_requests]` or [`rules`](../yaml/README.md#rules) syntax is used and the pull request is open. | | `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA` | 12.3 | all | The HEAD SHA of the target branch of the pull request if [the pipelines are for external pull requests](../ci_cd_for_external_repos/index.md#pipelines-for-external-pull-requests). Available only if `only: [external_pull_requests]` or [`rules`](../yaml/README.md#rules) syntax is used and the pull request is open. | -| `CI_JOB_ID` | 9.0 | all | The unique id of the current job that GitLab CI/CD uses internally | +| `CI_JOB_ID` | 9.0 | all | The unique ID of the current job that GitLab CI/CD uses internally | | `CI_JOB_IMAGE` | 12.9 | 12.9 | The name of the image running the CI job | | `CI_JOB_MANUAL` | 8.12 | all | The flag to indicate that job was manually started | | `CI_JOB_NAME` | 9.0 | 0.5 | The name of the job as defined in `.gitlab-ci.yml` | @@ -88,13 +88,13 @@ future GitLab releases.** | `CI_NODE_TOTAL` | 11.5 | all | Total number of instances of this job running in parallel. If the job is not parallelized, this variable is set to `1`. | | `CI_PAGES_DOMAIN` | 11.8 | all | The configured domain that hosts GitLab Pages. | | `CI_PAGES_URL` | 11.8 | all | URL to GitLab Pages-built pages. Always belongs to a subdomain of `CI_PAGES_DOMAIN`. | -| `CI_PIPELINE_ID` | 8.10 | all | The unique id of the current pipeline that GitLab CI/CD uses internally | -| `CI_PIPELINE_IID` | 11.0 | all | The unique id of the current pipeline scoped to project | +| `CI_PIPELINE_ID` | 8.10 | all | The unique ID of the current pipeline that GitLab CI/CD uses internally | +| `CI_PIPELINE_IID` | 11.0 | all | The unique ID of the current pipeline scoped to project | | `CI_PIPELINE_SOURCE` | 10.0 | all | Indicates how the pipeline was triggered. Possible options are: `push`, `web`, `trigger`, `schedule`, `api`, `pipeline`, `parent_pipeline`, `external`, `chat`, `merge_request_event`, and `external_pull_request_event`. For pipelines created before GitLab 9.5, this will show as `unknown` | | `CI_PIPELINE_TRIGGERED` | all | all | The flag to indicate that job was [triggered](../triggers/README.md) | | `CI_PIPELINE_URL` | 11.1 | 0.5 | Pipeline details URL | | `CI_PROJECT_DIR` | all | all | The full path where the repository is cloned and where the job is run. If the GitLab Runner `builds_dir` parameter is set, this variable is set relative to the value of `builds_dir`. For more information, see [Advanced configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section) for GitLab Runner. | -| `CI_PROJECT_ID` | all | all | The unique id of the current project that GitLab CI/CD uses internally | +| `CI_PROJECT_ID` | all | all | The unique ID of the current project that GitLab CI/CD uses internally | | `CI_PROJECT_NAME` | 8.10 | 0.5 | The name of the directory for the project that is currently being built. For example, if the project URL is `gitlab.example.com/group-name/project-1`, the `CI_PROJECT_NAME` would be `project-1`. | | `CI_PROJECT_NAMESPACE` | 8.10 | 0.5 | The project namespace (username or groupname) that is currently being built | | `CI_PROJECT_PATH` | 8.10 | 0.5 | The namespace with project name | @@ -110,7 +110,7 @@ future GitLab releases.** | `CI_REPOSITORY_URL` | 9.0 | all | The URL to clone the Git repository | | `CI_RUNNER_DESCRIPTION` | 8.10 | 0.5 | The description of the runner as saved in GitLab | | `CI_RUNNER_EXECUTABLE_ARCH` | all | 10.6 | The OS/architecture of the GitLab Runner executable (note that this is not necessarily the same as the environment of the executor) | -| `CI_RUNNER_ID` | 8.10 | 0.5 | The unique id of runner being used | +| `CI_RUNNER_ID` | 8.10 | 0.5 | The unique ID of runner being used | | `CI_RUNNER_REVISION` | all | 10.6 | GitLab Runner revision that is executing the current job | | `CI_RUNNER_SHORT_TOKEN` | all | 12.3 | First eight characters of GitLab Runner's token used to authenticate new job requests. Used as Runner's unique ID | | `CI_RUNNER_TAGS` | 8.10 | 0.5 | The defined runner tags | @@ -131,7 +131,7 @@ future GitLab releases.** | `GITLAB_CI` | all | all | Mark that job is executed in GitLab CI/CD environment | | `GITLAB_FEATURES` | 10.6 | all | The comma separated list of licensed features available for your instance and plan | | `GITLAB_USER_EMAIL` | 8.12 | all | The email of the user who started the job | -| `GITLAB_USER_ID` | 8.12 | all | The id of the user who started the job | +| `GITLAB_USER_ID` | 8.12 | all | The ID of the user who started the job | | `GITLAB_USER_LOGIN` | 10.0 | all | The login username of the user who started the job | | `GITLAB_USER_NAME` | 10.0 | all | The real name of the user who started the job | | `RESTORE_CACHE_ATTEMPTS` | 8.15 | 1.9 | Number of attempts to restore the cache running a job | diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 34ec8c09708..630a1845002 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -1641,7 +1641,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "title= ``` The above example is run by and administrator and will add an SSH public key -titled `ssh-key` to user's account which has an id of 25. +titled `ssh-key` to user's account which has an ID of 25. #### Escape special characters diff --git a/doc/development/emails.md b/doc/development/emails.md index 4f9af7d2839..01e39a13e4d 100644 --- a/doc/development/emails.md +++ b/doc/development/emails.md @@ -85,7 +85,7 @@ for the format of the email key: - Actions are always at the end, separated by `-`. For example `-issue` or `-merge-request` - If your feature is related to a project, the key begins with the project identifiers (project path slug - and project id), separated by `-`. For example, `gitlab-org-gitlab-foss-20` + and project ID), separated by `-`. For example, `gitlab-org-gitlab-foss-20` - Additional information, such as an author's token, can be added between the project identifiers and the action, separated by `-`. For example, `gitlab-org-gitlab-foss-20-Author_Token12345678-issue` - You register your handlers in `lib/gitlab/email/handler.rb` diff --git a/doc/development/fe_guide/style/vue.md b/doc/development/fe_guide/style/vue.md index 5ac289c42a8..46305cc7217 100644 --- a/doc/development/fe_guide/style/vue.md +++ b/doc/development/fe_guide/style/vue.md @@ -325,7 +325,7 @@ When using `v-for` you need to provide a *unique* `:key` attribute for each item </div> ``` -1. When the elements being iterated don't have a unique id, you can use the array index as the `:key` attribute +1. When the elements being iterated don't have a unique ID, you can use the array index as the `:key` attribute ```html <div diff --git a/doc/development/file_storage.md b/doc/development/file_storage.md index 230288844d7..8e70a0c8c09 100644 --- a/doc/development/file_storage.md +++ b/doc/development/file_storage.md @@ -30,18 +30,18 @@ they are still not 100% standardized. You can see them below: | Description | In DB? | Relative path (from CarrierWave.root) | Uploader class | model_type | | ------------------------------------- | ------ | ----------------------------------------------------------- | ---------------------- | ---------- | -| Instance logo | yes | uploads/-/system/appearance/logo/:id/:filename | `AttachmentUploader` | Appearance | -| Header logo | yes | uploads/-/system/appearance/header_logo/:id/:filename | `AttachmentUploader` | Appearance | -| Group avatars | yes | uploads/-/system/group/avatar/:id/:filename | `AvatarUploader` | Group | -| User avatars | yes | uploads/-/system/user/avatar/:id/:filename | `AvatarUploader` | User | -| User snippet attachments | yes | uploads/-/system/personal_snippet/:id/:random_hex/:filename | `PersonalFileUploader` | Snippet | -| Project avatars | yes | uploads/-/system/project/avatar/:id/:filename | `AvatarUploader` | Project | -| Issues/MR/Notes Markdown attachments | yes | uploads/:project_path_with_namespace/:random_hex/:filename | `FileUploader` | Project | -| Issues/MR/Notes Legacy Markdown attachments | no | uploads/-/system/note/attachment/:id/:filename | `AttachmentUploader` | Note | -| Design Management design thumbnails (EE) | yes | uploads/-/system/design_management/action/image_v432x230/:id/:filename | `DesignManagement::DesignV432x230Uploader` | DesignManagement::Action | -| CI Artifacts (CE) | yes | `shared/artifacts/:disk_hash[0..1]/:disk_hash[2..3]/:disk_hash/:year_:month_:date/:job_id/:job_artifact_id` (:disk_hash is SHA256 digest of project_id) | `JobArtifactUploader` | Ci::JobArtifact | -| LFS Objects (CE) | yes | shared/lfs-objects/:hex/:hex/:object_hash | `LfsObjectUploader` | LfsObject | -| External merge request diffs | yes | shared/external-diffs/merge_request_diffs/mr-:parent_id/diff-:id | `ExternalDiffUploader` | MergeRequestDiff | +| Instance logo | yes | `uploads/-/system/appearance/logo/:id/:filename` | `AttachmentUploader` | Appearance | +| Header logo | yes | `uploads/-/system/appearance/header_logo/:id/:filename` | `AttachmentUploader` | Appearance | +| Group avatars | yes | `uploads/-/system/group/avatar/:id/:filename` | `AvatarUploader` | Group | +| User avatars | yes | `uploads/-/system/user/avatar/:id/:filename` | `AvatarUploader` | User | +| User snippet attachments | yes | `uploads/-/system/personal_snippet/:id/:random_hex/:filename` | `PersonalFileUploader` | Snippet | +| Project avatars | yes | `uploads/-/system/project/avatar/:id/:filename` | `AvatarUploader` | Project | +| Issues/MR/Notes Markdown attachments | yes | `uploads/:project_path_with_namespace/:random_hex/:filename` | `FileUploader` | Project | +| Issues/MR/Notes Legacy Markdown attachments | no | `uploads/-/system/note/attachment/:id/:filename` | `AttachmentUploader` | Note | +| Design Management design thumbnails (EE) | yes | `uploads/-/system/design_management/action/image_v432x230/:id/:filename` | `DesignManagement::DesignV432x230Uploader` | DesignManagement::Action | +| CI Artifacts (CE) | yes | `shared/artifacts/:disk_hash[0..1]/:disk_hash[2..3]/:disk_hash/:year_:month_:date/:job_id/:job_artifact_id` (`:disk_hash` is SHA256 digest of `project_id`) | `JobArtifactUploader` | Ci::JobArtifact | +| LFS Objects (CE) | yes | `shared/lfs-objects/:hex/:hex/:object_hash` | `LfsObjectUploader` | LfsObject | +| External merge request diffs | yes | `shared/external-diffs/merge_request_diffs/mr-:parent_id/diff-:id` | `ExternalDiffUploader` | MergeRequestDiff | CI Artifacts and LFS Objects behave differently in CE and EE. In CE they inherit the `GitlabUploader` while in EE they inherit the `ObjectStorage` and store files in and S3 API compatible object store. diff --git a/doc/development/i18n/externalization.md b/doc/development/i18n/externalization.md index 66b0c8eb5e0..ba79c641995 100644 --- a/doc/development/i18n/externalization.md +++ b/doc/development/i18n/externalization.md @@ -536,9 +536,9 @@ The linter will take the following into account: - Variable usage - Only one unnamed (`%d`) variable, since the order of variables might change in different languages - - All variables used in the message-id are used in the translation + - All variables used in the message ID are used in the translation - There should be no variables used in a translation that aren't in the - message-id + message ID - Errors during translation. The errors are grouped per file, and per message ID: @@ -562,7 +562,7 @@ Errors in `locale/zh_TW/gitlab.po`: In this output the `locale/zh_HK/gitlab.po` has syntax errors. The `locale/zh_TW/gitlab.po` has variables that are used in the translation that -aren't in the message with id `1 pipeline`. +aren't in the message with ID `1 pipeline`. ## Adding a new language diff --git a/doc/development/internal_api.md b/doc/development/internal_api.md index e8fca7535b0..5b53f223eb0 100644 --- a/doc/development/internal_api.md +++ b/doc/development/internal_api.md @@ -40,7 +40,7 @@ POST /internal/allowed | Attribute | Type | Required | Description | |:----------|:-------|:---------|:------------| -| `key_id` | string | no | Id of the SSH-key used to connect to GitLab-shell | +| `key_id` | string | no | ID of the SSH-key used to connect to GitLab-shell | | `username` | string | no | Username from the certificate used to connect to GitLab-Shell | | `project` | string | no (if `gl_repository` is passed) | Path to the project | | `gl_repository` | string | no (if `project` is passed) | Path to the project | @@ -93,7 +93,7 @@ information for LFS clients when the repository is accessed over SSH. | Attribute | Type | Required | Description | |:----------|:-------|:---------|:------------| -| `key_id` | string | no | Id of the SSH-key used to connect to GitLab-shell | +| `key_id` | string | no | ID of the SSH-key used to connect to GitLab-shell | | `username`| string | no | Username from the certificate used to connect to GitLab-Shell | | `project` | string | no | Path to the project | @@ -151,14 +151,14 @@ Example response: - GitLab-shell -## Get user for user id or key +## Get user for user ID or key This endpoint is used when a user performs `ssh git@gitlab.com`. It discovers the user associated with an SSH key. | Attribute | Type | Required | Description | |:----------|:-------|:---------|:------------| -| `key_id` | integer | no | The id of the SSH key used as found in the authorized-keys file or through the `/authorized_keys` check | +| `key_id` | integer | no | The ID of the SSH key used as found in the authorized-keys file or through the `/authorized_keys` check | | `username` | string | no | Username of the user being looked up, used by GitLab-shell when authenticating using a certificate | ```plaintext @@ -223,7 +223,7 @@ recovery codes based on their SSH key | Attribute | Type | Required | Description | |:----------|:-------|:---------|:------------| -| `key_id` | integer | no | The id of the SSH key used as found in the authorized-keys file or through the `/authorized_keys` check | +| `key_id` | integer | no | The ID of the SSH key used as found in the authorized-keys file or through the `/authorized_keys` check | | `user_id` | integer | no | **Deprecated** User_id for which to generate new recovery codes | ```plaintext diff --git a/doc/development/namespaces_storage_statistics.md b/doc/development/namespaces_storage_statistics.md index f175739e55e..d6b2a7460cd 100644 --- a/doc/development/namespaces_storage_statistics.md +++ b/doc/development/namespaces_storage_statistics.md @@ -111,11 +111,11 @@ Directly relate the root namespace to its child namespaces, so whenever a namespace is created without a parent, this one is tagged with the root namespace ID: -| id | root_id | parent_id -|:---|:--------|:---------- -| 1 | 1 | NULL -| 2 | 1 | 1 -| 3 | 1 | 2 +| ID | root ID | parent ID | +|:---|:--------|:----------| +| 1 | 1 | NULL | +| 2 | 1 | 1 | +| 3 | 1 | 2 | To aggregate the statistics inside a namespace we'd execute something like: diff --git a/doc/development/ordering_table_columns.md b/doc/development/ordering_table_columns.md index cbfd05e731d..b68602ea30d 100644 --- a/doc/development/ordering_table_columns.md +++ b/doc/development/ordering_table_columns.md @@ -77,64 +77,64 @@ always be at the end of a table. Let's use the `events` table as an example, which currently has the following layout: -| Column | Type | Size | -|:------------|:----------------------------|:---------| -| id | integer | 4 bytes | -| target_type | character varying | variable | -| target_id | integer | 4 bytes | -| title | character varying | variable | -| data | text | variable | -| project_id | integer | 4 bytes | -| created_at | timestamp without time zone | 8 bytes | -| updated_at | timestamp without time zone | 8 bytes | -| action | integer | 4 bytes | -| author_id | integer | 4 bytes | +| Column | Type | Size | +|:--------------|:----------------------------|:---------| +| `id` | integer | 4 bytes | +| `target_type` | character varying | variable | +| `target_id` | integer | 4 bytes | +| `title` | character varying | variable | +| `data` | text | variable | +| `project_id` | integer | 4 bytes | +| `created_at` | timestamp without time zone | 8 bytes | +| `updated_at` | timestamp without time zone | 8 bytes | +| `action` | integer | 4 bytes | +| `author_id` | integer | 4 bytes | After adding padding to align the columns this would translate to columns being divided into fixed size chunks as follows: -| Chunk Size | Columns | -|:-----------|:------------------| -| 8 bytes | id | -| variable | target_type | -| 8 bytes | target_id | -| variable | title | -| variable | data | -| 8 bytes | project_id | -| 8 bytes | created_at | -| 8 bytes | updated_at | -| 8 bytes | action, author_id | +| Chunk Size | Columns | +|:-----------|:----------------------| +| 8 bytes | `id` | +| variable | `target_type` | +| 8 bytes | `target_id` | +| variable | `title` | +| variable | `data` | +| 8 bytes | `project_id` | +| 8 bytes | `created_at` | +| 8 bytes | `updated_at` | +| 8 bytes | `action`, `author_id` | This means that excluding the variable sized data and tuple header, we need at least 8 * 6 = 48 bytes per row. We can optimise this by using the following column order instead: -| Column | Type | Size | -|:------------|:----------------------------|:---------| -| created_at | timestamp without time zone | 8 bytes | -| updated_at | timestamp without time zone | 8 bytes | -| id | integer | 4 bytes | -| target_id | integer | 4 bytes | -| project_id | integer | 4 bytes | -| action | integer | 4 bytes | -| author_id | integer | 4 bytes | -| target_type | character varying | variable | -| title | character varying | variable | -| data | text | variable | +| Column | Type | Size | +|:--------------|:----------------------------|:---------| +| `created_at` | timestamp without time zone | 8 bytes | +| `updated_at` | timestamp without time zone | 8 bytes | +| `id` | integer | 4 bytes | +| `target_id` | integer | 4 bytes | +| `project_id` | integer | 4 bytes | +| `action` | integer | 4 bytes | +| `author_id` | integer | 4 bytes | +| `target_type` | character varying | variable | +| `title` | character varying | variable | +| `data` | text | variable | This would produce the following chunks: -| Chunk Size | Columns | -|:-----------|:-------------------| -| 8 bytes | created_at | -| 8 bytes | updated_at | -| 8 bytes | id, target_id | -| 8 bytes | project_id, action | -| 8 bytes | author_id | -| variable | target_type | -| variable | title | -| variable | data | +| Chunk Size | Columns | +|:-----------|:-----------------------| +| 8 bytes | `created_at` | +| 8 bytes | `updated_at` | +| 8 bytes | `id`, `target_id` | +| 8 bytes | `project_id`, `action` | +| 8 bytes | `author_id` | +| variable | `target_type` | +| variable | `title` | +| variable | `data` | Here we only need 40 bytes per row excluding the variable sized data and 24-byte tuple header. 8 bytes being saved may not sound like much, but for tables as diff --git a/doc/development/packages.md b/doc/development/packages.md index 8614f78d836..498fc2a83d9 100644 --- a/doc/development/packages.md +++ b/doc/development/packages.md @@ -74,7 +74,7 @@ It is using the top-level group or namespace as the defining portion of the name To avoid name conflict for instance-level endpoints you will need to define a package naming convention that gives a way to identify the project that the package belongs to. This generally involves using the project -id or full project path in the package name. See +ID or full project path in the package name. See [Conan's naming convention](../user/packages/conan_repository/index.md#package-recipe-naming-convention) as an example. For group and project-level endpoints, naming can be less constrained and it will be up to the group and project diff --git a/doc/development/polymorphic_associations.md b/doc/development/polymorphic_associations.md index 5d69c8add38..b6567704d8e 100644 --- a/doc/development/polymorphic_associations.md +++ b/doc/development/polymorphic_associations.md @@ -4,7 +4,7 @@ Rails makes it possible to define so called "polymorphic associations". This usually works by adding two columns to a table: a target type column, and a -target id. For example, at the time of writing we have such a setup for +target ID. For example, at the time of writing we have such a setup for `members` with the following columns: - `source_type`: a string defining the model to use, can be either `Project` or diff --git a/doc/integration/gitlab.md b/doc/integration/gitlab.md index 4e62f6389c8..f423863ce8e 100644 --- a/doc/integration/gitlab.md +++ b/doc/integration/gitlab.md @@ -24,9 +24,8 @@ GitLab.com will generate an application ID and secret key for you to use. 1. Select **Save application**. -1. You should now see a **Application Id** and **Secret** near the top right of the page (see screenshot). - Keep this page open as you continue configuration. -  +1. You should now see an **Application ID** and **Secret**. Keep this page open as you continue + configuration. 1. On your GitLab server, open the configuration file. diff --git a/doc/integration/img/gitlab_app.png b/doc/integration/img/gitlab_app.png Binary files differdeleted file mode 100644 index 228e8a01305..00000000000 --- a/doc/integration/img/gitlab_app.png +++ /dev/null diff --git a/doc/integration/jira_development_panel.md b/doc/integration/jira_development_panel.md index 188eca6b6a9..03dd96ac63a 100644 --- a/doc/integration/jira_development_panel.md +++ b/doc/integration/jira_development_panel.md @@ -62,7 +62,7 @@ There are no special requirements if you are using GitLab.com. - Check `api` in the Scopes section. -1. Click `Save application`. You will see the generated 'Application Id' and 'Secret' values. +1. Click `Save application`. You will see the generated 'Application ID' and 'Secret' values. Copy these values that you will use on the Jira configuration side. ## Jira Configuration diff --git a/doc/integration/slash_commands.md b/doc/integration/slash_commands.md index 11abf3ca203..c73db32a42a 100644 --- a/doc/integration/slash_commands.md +++ b/doc/integration/slash_commands.md @@ -14,11 +14,11 @@ Taking the trigger term as `project-name`, the commands are: | ------- | ------ | | `/project-name help` | Shows all available slash commands | | `/project-name issue new <title> <shift+return> <description>` | Creates a new issue with title `<title>` and description `<description>` | -| `/project-name issue show <id>` | Shows the issue with id `<id>` | -| `/project-name issue close <id>` | Closes the issue with id `<id>` | +| `/project-name issue show <id>` | Shows the issue with ID `<id>` | +| `/project-name issue close <id>` | Closes the issue with ID `<id>` | | `/project-name issue search <query>` | Shows up to 5 issues matching `<query>` | | `/project-name issue move <id> to <project>` | Moves issue ID `<id>` to `<project>` | -| `/project-name issue comment <id> <shift+return> <comment>` | Adds a new comment to an issue with id `<id>` and comment body `<comment>` | +| `/project-name issue comment <id> <shift+return> <comment>` | Adds a new comment to an issue with ID `<id>` and comment body `<comment>` | | `/project-name deploy <from> to <to>` | Deploy from the `<from>` environment to the `<to>` environment | | `/project-name run <job name> <arguments>` | Execute [ChatOps](../ci/chatops/README.md) job `<job name>` on `master` | diff --git a/doc/topics/autodevops/stages.md b/doc/topics/autodevops/stages.md index 662a78e046b..57fb20b67fd 100644 --- a/doc/topics/autodevops/stages.md +++ b/doc/topics/autodevops/stages.md @@ -241,6 +241,8 @@ You can disable DAST: - On all branches by setting the `DAST_DISABLED` environment variable to `"true"`. - Only on the default branch by setting the `DAST_DISABLED_FOR_DEFAULT_BRANCH` environment variable to `"true"`. +- Only on feature branches by setting `REVIEW_DISABLED` environment variable to + `"true"`. This also disables the Review App. ## Auto Browser Performance Testing **(PREMIUM)** diff --git a/doc/topics/git/lfs/index.md b/doc/topics/git/lfs/index.md index 8f84f8b8e17..33b7fa45691 100644 --- a/doc/topics/git/lfs/index.md +++ b/doc/topics/git/lfs/index.md @@ -154,7 +154,7 @@ also edit it: git lfs unlock images/banner.png ``` -You can also unlock by id: +You can also unlock by ID: ```shell git lfs unlock --id=123 diff --git a/doc/topics/git/numerous_undo_possibilities_in_git/index.md b/doc/topics/git/numerous_undo_possibilities_in_git/index.md index 9d175b2edb1..7fc10cb27e6 100644 --- a/doc/topics/git/numerous_undo_possibilities_in_git/index.md +++ b/doc/topics/git/numerous_undo_possibilities_in_git/index.md @@ -24,7 +24,7 @@ Git is really deleted](https://git-scm.com/book/en/v2/Git-Internals-Maintenance- This means that until Git automatically cleans detached commits (which cannot be accessed by branch or tag) it will be possible to view them with `git reflog` command -and access them with direct commit-id. Read more about _[redoing the undo](#redoing-the-undo)_ on the section below. +and access them with direct commit ID. Read more about _[redoing the undo](#redoing-the-undo)_ on the section below. ## Introduction @@ -233,7 +233,7 @@ last known good commit (we assume `A`) and first known bad commit (where bug was git bisect A..E ``` -Bisect will provide us with commit-id of the middle commit to test, and then guide us +Bisect will provide us with commit ID of the middle commit to test, and then guide us through simple bisection process. You can read more about it [in official Git Tools](https://git-scm.com/book/en/v2/Git-Tools-Debugging-with-Git) In our example we will end up with commit `B`, that introduced bug/error. We have 4 options on how to remove it (or part of it) from our repository. @@ -332,7 +332,7 @@ history](#how-modifying-history-is-done) Sometimes you realize that the changes you undid were useful and you want them back. Well because of first paragraph you are in luck. Command `git reflog` enables you to *recall* detached local commits by referencing or applying them -via commit-id. Although, do not expect to see really old commits in reflog, because +via commit ID. Although, do not expect to see really old commits in reflog, because Git regularly [cleans the commits which are *unreachable* by branches or tags](https://git-scm.com/book/en/v2/Git-Internals-Maintenance-and-Data-Recovery). To view repository history and to track older commits you can use below command: @@ -353,7 +353,7 @@ eb37e74 HEAD@{6}: rebase -i (pick): Commit C 6e43d59 HEAD@{16}: commit: Commit B ``` -Output of command shows repository history. In first column there is commit-id, +Output of command shows repository history. In first column there is commit ID, in following column, number next to `HEAD` indicates how many commits ago something was made, after that indicator of action that was made (commit, rebase, merge, ...) and then on end description of that action. @@ -393,7 +393,7 @@ passwords, SSH keys, etc. It is and should not be used to hide mistakes, as it will make it harder to debug in case there are some other bugs. The main reason for this is that you loose the real development progress. **Also keep in mind that, even with modified history, commits are just detached and can still be -accessed through commit-id** - at least until all repositories perform +accessed through commit ID** - at least until all repositories perform the cleanup of detached commits (happens automatically).  @@ -426,7 +426,7 @@ Never modify the commit history of `master` or shared branch. After you know what you want to modify (how far in history or how which range of old commits), use `git rebase -i commit-id`. This command will then display all the commits from -current version to chosen commit-id and allow modification, squashing, deletion +current version to chosen commit ID and allow modification, squashing, deletion of that commits. ```shell diff --git a/doc/university/training/topics/agile_git.md b/doc/university/training/topics/agile_git.md index 6434b710159..c5634bec27b 100644 --- a/doc/university/training/topics/agile_git.md +++ b/doc/university/training/topics/agile_git.md @@ -20,7 +20,7 @@ Branching in an Agile environment usually happens around user stories with one or more developers working on it. If more than one developer then another branch for each developer is also used -with their initials, and US id. +with their initials, and US ID. After its tested merge into master and remove the branch. diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index 76dfcc901fd..5a246c3bbe2 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -418,7 +418,7 @@ the report JSON unless stated otherwise. Presence of optional fields depends on | `vulnerabilities[].confidence` | How reliable the vulnerability's assessment is. Possible values: `Ignore`, `Unknown`, `Experimental`, `Low`, `Medium`, `High`, `Confirmed`. **Note:** Our current container scanning tool based on [klar](https://github.com/optiopay/klar) does not provide a confidence level, so this value is currently hardcoded to `Unknown`. | | `vulnerabilities[].solution` | Explanation of how to fix the vulnerability. Optional. | | `vulnerabilities[].scanner` | A node that describes the analyzer used to find this vulnerability. | -| `vulnerabilities[].scanner.id` | Id of the scanner as a snake_case string. | +| `vulnerabilities[].scanner.id` | ID of the scanner as a snake_case string. | | `vulnerabilities[].scanner.name` | Name of the scanner, for display purposes. | | `vulnerabilities[].location` | A node that tells where the vulnerability is located. | | `vulnerabilities[].location.dependency` | A node that describes the dependency of a project where the vulnerability is located. | @@ -437,7 +437,7 @@ the report JSON unless stated otherwise. Presence of optional fields depends on | `vulnerabilities[].links[].url` | URL of the vulnerability details document. Optional. | | `remediations` | An array of objects containing information on cured vulnerabilities along with patch diffs to apply. Empty if no remediations provided by an underlying analyzer. | | `remediations[].fixes` | An array of strings that represent references to vulnerabilities fixed by this particular remediation. | -| `remediations[].fixes[].id` | The id of a fixed vulnerability. | +| `remediations[].fixes[].id` | The ID of a fixed vulnerability. | | `remediations[].fixes[].cve` | (**DEPRECATED - use `remediations[].fixes[].id` instead**) A string value that describes a fixed vulnerability in the same format as `vulnerabilities[].cve`. | | `remediations[].summary` | Overview of how the vulnerabilities have been fixed. | | `remediations[].diff` | base64-encoded remediation code diff, compatible with [`git apply`](https://git-scm.com/docs/git-format-patch#_discussion). | diff --git a/doc/user/application_security/sast/analyzers.md b/doc/user/application_security/sast/analyzers.md index 9010a7cae0b..4de58de4304 100644 --- a/doc/user/application_security/sast/analyzers.md +++ b/doc/user/application_security/sast/analyzers.md @@ -149,7 +149,7 @@ The [Security Scanner Integration](../../../development/integrations/secure.md) | End line | ✓ | ✓ | 𐄂 | ✓ | ✓ | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | ✓ | | Start column | ✓ | 𐄂 | 𐄂 | ✓ | ✓ | ✓ | ✓ | 𐄂 | 𐄂 | ✓ | ✓ | 𐄂 | ✓ | | End column | ✓ | 𐄂 | 𐄂 | ✓ | ✓ | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | ✓ | -| External id (e.g. CVE) | 𐄂 | 𐄂 | ⚠ | 𐄂 | ⚠ | ✓ | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | +| External ID (e.g. CVE) | 𐄂 | 𐄂 | ⚠ | 𐄂 | ⚠ | ✓ | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | | URLs | ✓ | 𐄂 | ✓ | 𐄂 | ⚠ | 𐄂 | ⚠ | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | | Internal doc/explanation | ✓ | ⚠ | ✓ | 𐄂 | ✓ | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | ✓ | 𐄂 | | Solution | ✓ | 𐄂 | 𐄂 | 𐄂 | ⚠ | ✓ | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | 𐄂 | diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md index 9299d096851..6f74359137e 100644 --- a/doc/user/application_security/sast/index.md +++ b/doc/user/application_security/sast/index.md @@ -462,7 +462,7 @@ the report JSON unless stated otherwise. Presence of optional fields depends on | `vulnerabilities[].confidence` | How reliable the vulnerability's assessment is. Possible values: `Ignore`, `Unknown`, `Experimental`, `Low`, `Medium`, `High`, `Confirmed`. | | `vulnerabilities[].solution` | Explanation of how to fix the vulnerability. Optional. | | `vulnerabilities[].scanner` | A node that describes the analyzer used to find this vulnerability. | -| `vulnerabilities[].scanner.id` | Id of the scanner as a snake_case string. | +| `vulnerabilities[].scanner.id` | ID of the scanner as a snake_case string. | | `vulnerabilities[].scanner.name` | Name of the scanner, for display purposes. | | `vulnerabilities[].location` | A node that tells where the vulnerability is located. | | `vulnerabilities[].location.file` | Path to the file where the vulnerability is located. Optional. | diff --git a/doc/user/packages/maven_repository/index.md b/doc/user/packages/maven_repository/index.md index 34716945e6c..bc40961d00f 100644 --- a/doc/user/packages/maven_repository/index.md +++ b/doc/user/packages/maven_repository/index.md @@ -673,7 +673,7 @@ The example below shows how to create a new package each time the `master` branc is updated: 1. Create a `ci_settings.xml` file that will serve as Maven's `settings.xml` file. - Add the server section with the same id you defined in your `pom.xml` file. + Add the server section with the same ID you defined in your `pom.xml` file. For example, in our case it's `gitlab-maven`: ```xml diff --git a/doc/user/packages/nuget_repository/index.md b/doc/user/packages/nuget_repository/index.md index ed936b546d2..cb769b34b53 100644 --- a/doc/user/packages/nuget_repository/index.md +++ b/doc/user/packages/nuget_repository/index.md @@ -201,7 +201,7 @@ nuget install <package_id> -OutputDirectory <output_directory> \ Where: -- `<package_id>` is the package id. +- `<package_id>` is the package ID. - `<output_directory>` is the output directory, where the package will be installed. - `<package_version>` (Optional) is the package version. - `<source_name>` (Optional) is the source name. @@ -222,5 +222,5 @@ dotnet add package <package_id> \ Where: -- `<package_id>` is the package id. +- `<package_id>` is the package ID. - `<package_version>` (Optional) is the package version. diff --git a/doc/user/packages/pypi_repository/index.md b/doc/user/packages/pypi_repository/index.md index 2904ce06531..250c062039a 100644 --- a/doc/user/packages/pypi_repository/index.md +++ b/doc/user/packages/pypi_repository/index.md @@ -225,7 +225,7 @@ Where: - `<package_name>` is the package name. - `<personal_access_token>` is a personal access token with the `read_api` scope. -- `<project_id>` is the project id number. +- `<project_id>` is the project ID. If you were following the guide above and want to test installing the `MyPyPiPackage` package, you can run the following: diff --git a/doc/user/profile/notifications.md b/doc/user/profile/notifications.md index a67716ab0d0..ae00f3ace57 100644 --- a/doc/user/profile/notifications.md +++ b/doc/user/profile/notifications.md @@ -211,17 +211,17 @@ The following table lists all GitLab-specific email headers: | Header | Description | |------------------------------------|-------------------------------------------------------------------------| -| X-GitLab-Group-Id **(PREMIUM)** | The group's ID. Only present on notification emails for epics. | -| X-GitLab-Group-Path **(PREMIUM)** | The group's path. Only present on notification emails for epics. | -| X-GitLab-Project | The name of the project the notification belongs to. | -| X-GitLab-Project-Id | The project's ID. | -| X-GitLab-Project-Path | The project's path. | -| X-GitLab-(Resource)-ID | The ID of the resource the notification is for. The resource, for example, can be `Issue`, `MergeRequest`, `Commit`, or another such resource. | -| X-GitLab-Discussion-ID | The ID of the thread the comment belongs to, in notification emails for comments. | -| X-GitLab-Pipeline-Id | The ID of the pipeline the notification is for, in notification emails for pipelines. | -| X-GitLab-Reply-Key | A unique token to support reply by email. | -| X-GitLab-NotificationReason | The reason for the notification. This can be `mentioned`, `assigned`, or `own_activity`. | -| List-Id | The path of the project in an RFC 2919 mailing list identifier. This is useful for email organization with filters, for example. | +| `X-GitLab-Group-Id` **(PREMIUM)** | The group's ID. Only present on notification emails for epics. | +| `X-GitLab-Group-Path` **(PREMIUM)** | The group's path. Only present on notification emails for epics. | +| `X-GitLab-Project` | The name of the project the notification belongs to. | +| `X-GitLab-Project-Id` | The project's ID. | +| `X-GitLab-Project-Path` | The project's path. | +| `X-GitLab-(Resource)-ID` | The ID of the resource the notification is for. The resource, for example, can be `Issue`, `MergeRequest`, `Commit`, or another such resource. | +| `X-GitLab-Discussion-ID` | The ID of the thread the comment belongs to, in notification emails for comments. | +| `X-GitLab-Pipeline-Id` | The ID of the pipeline the notification is for, in notification emails for pipelines. | +| `X-GitLab-Reply-Key` | A unique token to support reply by email. | +| `X-GitLab-NotificationReason` | The reason for the notification. This can be `mentioned`, `assigned`, or `own_activity`. | +| `List-Id` | The path of the project in an RFC 2919 mailing list identifier. This is useful for email organization with filters, for example. | ### X-GitLab-NotificationReason diff --git a/doc/user/project/integrations/webhooks.md b/doc/user/project/integrations/webhooks.md index 6dd2fd3b61b..89e84dda0e8 100644 --- a/doc/user/project/integrations/webhooks.md +++ b/doc/user/project/integrations/webhooks.md @@ -1294,7 +1294,7 @@ X-Gitlab-Event: Job Hook } ``` -Note that `commit.id` is the id of the pipeline, not the id of the commit. +Note that `commit.id` is the ID of the pipeline, not the ID of the commit. ## Image URL rewriting diff --git a/doc/user/project/issues/csv_export.md b/doc/user/project/issues/csv_export.md index ec53b3dbbba..af01534a67f 100644 --- a/doc/user/project/issues/csv_export.md +++ b/doc/user/project/issues/csv_export.md @@ -70,7 +70,7 @@ Data will be encoded with a comma as the column delimiter, with `"` used to quot | Labels | Title of any labels joined with a `,` | | Time Estimate | [Time estimate](../time_tracking.md#estimates) in seconds | | Time Spent | [Time spent](../time_tracking.md#time-spent) in seconds | -| Epic ID | Id of the parent epic **(ULTIMATE)**, introduced in 12.7 | +| Epic ID | ID of the parent epic **(ULTIMATE)**, introduced in 12.7 | | Epic Title | Title of the parent epic **(ULTIMATE)**, introduced in 12.7 | ## Limitations diff --git a/doc/user/project/operations/error_tracking.md b/doc/user/project/operations/error_tracking.md index a95459e093a..fde4f7e64b3 100644 --- a/doc/user/project/operations/error_tracking.md +++ b/doc/user/project/operations/error_tracking.md @@ -53,7 +53,7 @@ From error list, users can navigate to the error details page by clicking the ti This page has: - A link to the Sentry issue. -- A link to the GitLab commit if the Sentry [release id/version](https://docs.sentry.io/workflow/releases/?platform=javascript#configure-sdk) on the Sentry Issue's first release matches a commit SHA in your GitLab hosted project. +- A link to the GitLab commit if the Sentry [release ID/version](https://docs.sentry.io/workflow/releases/?platform=javascript#configure-sdk) on the Sentry Issue's first release matches a commit SHA in your GitLab hosted project. - Other details about the issue, including a full stack trace. - In [GitLab 12.7 and newer](https://gitlab.com/gitlab-org/gitlab/issues/36246), language and urgency are displayed. diff --git a/doc/user/project/operations/feature_flags.md b/doc/user/project/operations/feature_flags.md index fb6b808c47c..8a8dd4781b6 100644 --- a/doc/user/project/operations/feature_flags.md +++ b/doc/user/project/operations/feature_flags.md @@ -273,7 +273,7 @@ func main() { Here's an example of how to integrate the feature flags in a Ruby application. -The Unleash client is given a user id for use with a **Percent rollout (logged in users)** rollout strategy or a list of **Target Users**. +The Unleash client is given a user ID for use with a **Percent rollout (logged in users)** rollout strategy or a list of **Target Users**. ```ruby #!/usr/bin/env ruby diff --git a/doc/user/project/service_desk.md b/doc/user/project/service_desk.md index 5c1b952384d..b8aa797cb7b 100644 --- a/doc/user/project/service_desk.md +++ b/doc/user/project/service_desk.md @@ -1,4 +1,4 @@ -# Service Desk **(Starter)** +# Service Desk **(STARTER)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/149) in [GitLab Premium 9.1](https://about.gitlab.com/releases/2017/04/22/gitlab-9-1-released/#service-desk-eep). |
