diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 21:09:29 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 21:09:29 +0300 |
commit | 0e5ce539275e32cfd7592362e03673807fca9cc7 (patch) | |
tree | 9d2c10afd7965a6dec4a48a36f9d0c886f55247c /doc | |
parent | 977720d7565377672df302ecb82b1e7a221cfba6 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/integrations.md | 11 | ||||
-rw-r--r-- | doc/development/code_review.md | 2 | ||||
-rw-r--r-- | doc/development/documentation/restful_api_styleguide.md | 18 | ||||
-rw-r--r-- | doc/development/rake_tasks.md | 2 |
4 files changed, 22 insertions, 11 deletions
diff --git a/doc/api/integrations.md b/doc/api/integrations.md index 7e7a514acf4..85549933c92 100644 --- a/doc/api/integrations.md +++ b/doc/api/integrations.md @@ -644,6 +644,17 @@ Parameters: | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `webhook` | string | true | Discord webhook. For example, `https://discord.com/api/webhooks/…` | +| `branches_to_be_notified` | string | false | Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is "default" | +| `confidential_issues_events` | boolean | false | Enable notifications for confidential issue events | +| `confidential_note_events` | boolean | false | Enable notifications for confidential note events | +| `issues_events` | boolean | false | Enable notifications for issue events | +| `merge_requests_events` | boolean | false | Enable notifications for merge request events | +| `note_events` | boolean | false | Enable notifications for note events | +| `notify_only_broken_pipelines` | boolean | false | Send notifications for broken pipelines | +| `pipeline_events` | boolean | false | Enable notifications for pipeline events | +| `push_events` | boolean | false | Enable notifications for push events | +| `tag_push_events` | boolean | false | Enable notifications for tag push events | +| `wiki_page_events` | boolean | false | Enable notifications for wiki page events | ### Disable Discord integration diff --git a/doc/development/code_review.md b/doc/development/code_review.md index 2091af0d9ae..e9f00b640d9 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -764,7 +764,7 @@ A merge request may benefit from being considered a customer critical priority b Properties of customer critical merge requests: -- The [VP of Development](https://about.gitlab.com/job-families/engineering/development/management/vp/) ([@clefelhocz1](https://gitlab.com/clefelhocz1)) is the DRI for deciding if a merge request qualifies as customer critical. +- The [VP of Development](https://about.gitlab.com/job-families/engineering/development/management/vp/) ([@clefelhocz1](https://gitlab.com/clefelhocz1)) is the approver for deciding if a merge request qualifies as customer critical. Also, if two of his direct reports approve, that can also serve as approval. - The DRI applies the `customer-critical-merge-request` label to the merge request. - It is required that the reviewers and maintainers involved with a customer critical merge request are engaged as soon as this decision is made. - It is required to prioritize work for those involved on a customer critical merge request so that they have the time available necessary to focus on it. diff --git a/doc/development/documentation/restful_api_styleguide.md b/doc/development/documentation/restful_api_styleguide.md index 4964b66afd1..c39c7c02108 100644 --- a/doc/development/documentation/restful_api_styleguide.md +++ b/doc/development/documentation/restful_api_styleguide.md @@ -81,7 +81,7 @@ Example request: ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" \ - "https://gitlab.example.com/api/v4/endpoint?parameters" + --url "https://gitlab.example.com/api/v4/endpoint?parameters" ``` Example response: @@ -204,7 +204,7 @@ For information about writing attribute descriptions, see the [GraphQL API descr include it. - Use long option names (`--header` instead of `-H`) for legibility. (Tested in [`scripts/lint-doc.sh`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/scripts/lint-doc.sh).) -- Wrap the URL in double quotes (`"`). +- Declare URLs with the `--url` parameter, and wrap the URL in double quotes (`"`). - Prefer to use examples using the personal access token and don't pass data of username and password. - For legibility, use the <code>\</code> character and indentation to break long single-line @@ -233,7 +233,7 @@ Get the details of a group: ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" \ - "https://gitlab.example.com/api/v4/groups/gitlab-org" + --url "https://gitlab.example.com/api/v4/groups/gitlab-org" ``` ### cURL example with parameters passed in the URL @@ -242,7 +242,7 @@ Create a new project under the authenticated user's namespace: ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ - "https://gitlab.example.com/api/v4/projects?name=foo" + --url "https://gitlab.example.com/api/v4/projects?name=foo" ``` ### Post data using cURL's `--data` @@ -254,7 +254,7 @@ can use cURL's `--data` option. The example below will create a new project ```shell curl --data "name=foo" \ --header "PRIVATE-TOKEN: <your_access_token>" \ - "https://gitlab.example.com/api/v4/projects" + --url "https://gitlab.example.com/api/v4/projects" ``` ### Post data using JSON content @@ -267,7 +267,7 @@ curl --request POST \ --header "PRIVATE-TOKEN: <your_access_token>" \ --header "Content-Type: application/json" \ --data '{"path": "my-group", "name": "My group"}' \ - "https://gitlab.example.com/api/v4/groups" + --url "https://gitlab.example.com/api/v4/groups" ``` For readability, you can also set up the `--data` by using the following format: @@ -293,7 +293,7 @@ curl --request POST \ --header "PRIVATE-TOKEN: <your_access_token>" \ --form "title=ssh-key" \ --form "key=ssh-rsa AAAAB3NzaC1yc2EA..." \ - "https://gitlab.example.com/api/v4/users/25/keys" + --url "https://gitlab.example.com/api/v4/users/25/keys" ``` The above example is run by and administrator and will add an SSH public key @@ -309,7 +309,7 @@ ASCII code. ```shell curl --request POST \ --header "PRIVATE-TOKEN: <your_access_token>" \ - "https://gitlab.example.com/api/v4/projects/42/issues?title=Hello%20GitLab" + --url "https://gitlab.example.com/api/v4/projects/42/issues?title=Hello%20GitLab" ``` Use `%2F` for slashes (`/`). @@ -325,5 +325,5 @@ curl --request PUT \ --header "PRIVATE-TOKEN: <your_access_token>" --data "skip_users[]=<user_id>" \ --data "skip_users[]=<user_id>" \ - "https://gitlab.example.com/api/v4/projects/<project_id>/users" + --url "https://gitlab.example.com/api/v4/projects/<project_id>/users" ``` diff --git a/doc/development/rake_tasks.md b/doc/development/rake_tasks.md index 8261330223d..0305cbf25b4 100644 --- a/doc/development/rake_tasks.md +++ b/doc/development/rake_tasks.md @@ -310,7 +310,7 @@ One way to generate the initial list is to run the Rake task `rubocop:todo:gener bundle exec rake rubocop:todo:generate ``` -To generate TODO list for specific RuboCop rules, pass them comma-seperated as +To generate TODO list for specific RuboCop rules, pass them comma-separated as argument to the Rake task: ```shell |