diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-05 21:10:06 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-05 21:10:06 +0300 |
commit | c8419b0227e069a7403f41589f1d0ef690e762f1 (patch) | |
tree | 7009382402811f9e32b448f68f7f90912237aa03 /doc/user | |
parent | 6659634b2bdc3ba362574541985c6852ad1574a4 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/project/badges.md | 77 | ||||
-rw-r--r-- | doc/user/project/merge_requests/ai_in_merge_requests.md | 4 | ||||
-rw-r--r-- | doc/user/project/merge_requests/creating_merge_requests.md | 3 | ||||
-rw-r--r-- | doc/user/project/repository/index.md | 3 | ||||
-rw-r--r-- | doc/user/project/repository/signed_commits/ssh.md | 3 | ||||
-rw-r--r-- | doc/user/shortcuts.md | 2 |
6 files changed, 44 insertions, 48 deletions
diff --git a/doc/user/project/badges.md b/doc/user/project/badges.md index 39c1d228d63..0e478e2e397 100644 --- a/doc/user/project/badges.md +++ b/doc/user/project/badges.md @@ -126,26 +126,6 @@ If you set an out of range value, GitLab automatically adjusts it to the default Badges can be added to a project by Maintainers or Owners, and are visible on the project's overview page. If you find that you have to add the same badges to several projects, you may want to add them at the [group level](#group-badges). -### Add a badge to a project - -To add a new badge to a project: - -1. On the left sidebar, select **Search or go to** and find your project. -1. Select **Settings > General**. -1. Expand **Badges**. -1. Select **Add badge**. -1. Under **Link**, enter the URL that the badges should point to. -1. Under **Badge image URL**, enter the URL of the image that should be displayed. -1. Select **Add badge**. - -After adding a badge to a project, you can see the badge in the list below the form. - -### Edit or delete a project badge - -To edit a badge, select **Edit** (**{pencil}**). - -To delete a badge, select **Delete** (**{remove}**). - ### Example project badge: Pipeline Status A common project badge presents the GitLab CI pipeline status. @@ -177,26 +157,26 @@ If you need individual badges for each project, either: - Add the badge at the [project level](#project-badges). - Use [placeholders](#placeholders). -### Add a badge to a group +## View badges -To add a new badge to a group: +To view badges available in a project or group: -1. On the left sidebar, select **Search or go to** and find your group. +1. On the left sidebar, select **Search or go to** and find your project or group. 1. Select **Settings > General**. 1. Expand **Badges**. -1. Under "Link", enter the URL that the badges should point to and under - "Badge image URL" the URL of the image that should be displayed. -1. Select **Add badge**. - -After adding a badge to a group, you can see it in the list below the form. -### Edit or delete a group badge +## Add a badge -To edit a badge, select **Edit** (**{pencil}**). +To add a new badge to a project or group: -To delete a badge, select **Delete** (**{remove}**). - -Badges associated with a group can be edited or deleted only at the [group level](#group-badges). +1. On the left sidebar, select **Search or go to** and find your project or group. +1. Select **Settings > General**. +1. Expand **Badges**. +1. Select **Add badge**. +1. In the **Name** text box, enter the name of your badge. +1. In the **Link** text box, enter the URL that the badges should point to. +1. In the **Badge image URL** text box, enter the URL of the image you want to display for the badge. +1. Select **Add badge**. ## View the URL of pipeline badges @@ -283,6 +263,31 @@ To add a new badge with a custom image to a group or project: To learn how to use custom images generated through a pipeline, see the documentation on [accessing the latest job artifacts by URL](../../ci/jobs/job_artifacts.md#from-a-url). +## Edit a badge + +To edit a badge in a project or group: + +1. On the left sidebar, select **Search or go to** and find your project or group. +1. Select **Settings > General**. +1. Expand **Badges**. +1. Next to the badge you want to edit, select **Edit** (**{pencil}**). +1. Edit the **Name**, **Link**, or **Badge image URL**. +1. Select **Save changes**. + +## Delete a badge + +To delete a badge in a project or group: + +1. On the left sidebar, select **Search or go to** and find your project or group. +1. Select **Settings > General**. +1. Expand **Badges**. +1. Next to the badge you want to delete, select **Delete** (**{remove}**). +1. On the confirmation dialog, select **Delete badge**. +1. Select **Save changes**. + +NOTE: +Badges associated with a group can be edited or deleted only at the [group level](#group-badges). + ## Placeholders Both the URL a badge points to and the image URL can contain placeholders, @@ -302,9 +307,3 @@ Placeholders allow badges to expose otherwise-private information, such as the default branch or commit SHA when the project is configured to have a private repository. This behavior is intentional, as badges are intended to be used publicly. Avoid using these placeholders if the information is sensitive. - -## Configure badges through the API - -You can also configure badges via the GitLab API. As in the settings, there is -a distinction between endpoints for badges at the -[project level](../../api/project_badges.md) and [group level](../../api/group_badges.md). diff --git a/doc/user/project/merge_requests/ai_in_merge_requests.md b/doc/user/project/merge_requests/ai_in_merge_requests.md index 2b4b28dafa2..d84bd4c0c07 100644 --- a/doc/user/project/merge_requests/ai_in_merge_requests.md +++ b/doc/user/project/merge_requests/ai_in_merge_requests.md @@ -93,7 +93,7 @@ Provide feedback on this experimental feature in [issue 408994](https://gitlab.c **Data usage**: When you use this feature, the following data is sent to the large language model referenced above: - Contents of the file -- The filename +- The file name ## Generate suggested tests in merge requests @@ -118,4 +118,4 @@ Feedback on this experimental feature can be provided in [issue 408995](https:// **Data usage**: When you use this feature, the following data is sent to the large language model referenced above: - Contents of the file -- The filename +- The file name diff --git a/doc/user/project/merge_requests/creating_merge_requests.md b/doc/user/project/merge_requests/creating_merge_requests.md index 752ee1e7c40..346a10c849d 100644 --- a/doc/user/project/merge_requests/creating_merge_requests.md +++ b/doc/user/project/merge_requests/creating_merge_requests.md @@ -189,8 +189,7 @@ A merge request is created. ### Add attachments when creating a merge request by email You can add commits to a merge request by adding -patches as attachments to the email. All attachments with a filename -ending in `.patch` are considered patches and are processed +patches as attachments to the email. All attachments with a file name ending in `.patch` are considered patches and are processed ordered by name. The combined size of the patches can be 2 MB. diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index 870cfbc9148..28bd0ad7215 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -209,8 +209,7 @@ These files can either be plain text or have the extension of a > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19515) in GitLab 12.6. -GitLab can render OpenAPI specification files. The filename -must include `openapi` or `swagger` and the extension must be `yaml`, +GitLab can render OpenAPI specification files. The file name must include `openapi` or `swagger` and the extension must be `yaml`, `yml`, or `json`. The following examples are all correct: - `openapi.yml` diff --git a/doc/user/project/repository/signed_commits/ssh.md b/doc/user/project/repository/signed_commits/ssh.md index c87a992fdac..e1c2a73be3e 100644 --- a/doc/user/project/repository/signed_commits/ssh.md +++ b/doc/user/project/repository/signed_commits/ssh.md @@ -48,8 +48,7 @@ To configure Git to use your key: git config --global gpg.format ssh ``` -1. Specify which public SSH key to use as the signing key and change the filename - (`~/.ssh/examplekey.pub`) to the location of your key. The filename might +1. Specify which public SSH key to use as the signing key and change the file name (`~/.ssh/examplekey.pub`) to the location of your key. The file name might differ, depending on how you generated your key: ```shell diff --git a/doc/user/shortcuts.md b/doc/user/shortcuts.md index e504ee90821..566af81d31b 100644 --- a/doc/user/shortcuts.md +++ b/doc/user/shortcuts.md @@ -77,7 +77,7 @@ relatively quickly to work, and they take you to another page in the project. | <kbd>g</kbd> + <kbd>n</kbd> | Go to the [repository graph](#repository-graph) page (**Code > Repository graph**). | | <kbd>g</kbd> + <kbd>d</kbd> | Go to repository charts (**Analyze > Repository analytics**). | | <kbd>g</kbd> + <kbd>i</kbd> | Go to the project issues list (**Plan > Issues**). | -| <kbd>i</kbd> | Go to the New Issue page (**Pan > Issues**, select **New issue** ). | +| <kbd>i</kbd> | Go to the New Issue page (**Plan > Issues**, select **New issue** ). | | <kbd>g</kbd> + <kbd>b</kbd> | Go to the project issue boards list (**Plan > Issue boards**). | | <kbd>g</kbd> + <kbd>m</kbd> | Go to the project [merge requests](project/merge_requests/index.md) list (**Code > Merge requests**). | | <kbd>g</kbd> + <kbd>p</kbd> | Go to the CI/CD pipelines list (**Build > Pipelines**). | |