diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-13 15:07:18 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-13 15:07:18 +0300 |
commit | c3eeb6a8d6a4b11f0bc5e5eb1ed43b0726f1ea26 (patch) | |
tree | 7283014bb12ce53b57d2703b229095ad58e6d820 /doc/user | |
parent | 10e15ac3c2798956ff6a43d7b36bdf86c68aa817 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/group/access_and_permissions.md | 4 | ||||
-rw-r--r-- | doc/user/group/index.md | 16 | ||||
-rw-r--r-- | doc/user/group/manage.md | 18 | ||||
-rw-r--r-- | doc/user/group/moderate_users.md | 4 | ||||
-rw-r--r-- | doc/user/group/subgroups/index.md | 4 | ||||
-rw-r--r-- | doc/user/project/integrations/index.md | 1 | ||||
-rw-r--r-- | doc/user/project/integrations/telegram.md | 55 | ||||
-rw-r--r-- | doc/user/project/integrations/webhook_events.md | 3 | ||||
-rw-r--r-- | doc/user/project/repository/code_suggestions.md | 6 |
9 files changed, 85 insertions, 26 deletions
diff --git a/doc/user/group/access_and_permissions.md b/doc/user/group/access_and_permissions.md index a0191ba3369..8aee3c06192 100644 --- a/doc/user/group/access_and_permissions.md +++ b/doc/user/group/access_and_permissions.md @@ -282,8 +282,8 @@ To create group links via filter: LDAP user permissions can be manually overridden by an administrator. To override a user's permissions: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Group information > Members**. If LDAP synchronization +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Manage > Members**. If LDAP synchronization has granted a user a role with: - More permissions than the parent group membership, that user is displayed as having [direct membership](../project/members/index.md#display-direct-members) of the group. diff --git a/doc/user/group/index.md b/doc/user/group/index.md index e6d6034e4b2..4119d94597b 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -181,8 +181,8 @@ In lists of group members, entries can display the following badges: You can search for members by name, username, or email. -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Group information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Manage > Members**. 1. Above the list of members, in the **Filter members** box, enter search criteria. 1. To the right of the **Filter members** box, select the magnifying glass (**{search}**). @@ -190,8 +190,8 @@ You can search for members by name, username, or email. You can sort members by **Account**, **Access granted**, **Max role**, or **Last sign-in**. -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Group information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Manage > Members**. 1. Above the list of members, in the upper-right corner, from the **Account** list, select the criteria to filter by. 1. To switch the sort between ascending and descending, to the right of the **Account** list, select the @@ -205,8 +205,8 @@ Prerequisite: - You must have the Owner role. -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Group information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Manage > Members**. 1. Select **Invite members**. 1. Fill in the fields. - The role applies to all projects in the group. For more information, see [permissions](../permissions.md). @@ -231,8 +231,8 @@ Prerequisites: To remove a member from a group: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Group information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Manage > Members**. 1. Next to the member you want to remove, select **Remove member**. 1. Optional. On the **Remove member** confirmation box: - To remove direct user membership from subgroups and projects, select the **Also remove direct user membership from subgroups and projects** checkbox. diff --git a/doc/user/group/manage.md b/doc/user/group/manage.md index ec419336798..e135964c6e6 100644 --- a/doc/user/group/manage.md +++ b/doc/user/group/manage.md @@ -41,13 +41,13 @@ You can change the owner of a group. Each group must always have at least one member with the Owner role. - As an administrator: - 1. On the top bar, select **Main menu > Groups** and find your group. - 1. On the left sidebar, select **Group information > Members**. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. + 1. On the left sidebar, select **Manage > Members**. 1. Give a different member the **Owner** role. 1. Refresh the page. You can now remove the **Owner** role from the original owner. - As the current group's owner: - 1. On the top bar, select **Main menu > Groups** and find your group. - 1. On the left sidebar, select **Group information > Members**. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. + 1. On the left sidebar, select **Manage > Members**. 1. Give a different member the **Owner** role. 1. Have the new owner sign in and remove the **Owner** role from you. @@ -120,7 +120,7 @@ To share a given group, for example, `Frontend` with another group, for example, `Engineering`: 1. Go to the `Frontend` group. -1. On the left sidebar, select **Group information > Members**. +1. On the left sidebar, select **Manage > Members**. 1. Select **Invite a group**. 1. In the **Select a group to invite** list, select `Engineering`. 1. Select a [role](../permissions.md) as maximum access level. @@ -206,8 +206,8 @@ To disable group mentions: You can export a list of members in a group or subgroup as a CSV. -1. On the top bar, select **Main menu > Groups** and find your group or subgroup. -1. On the left sidebar, select either **Group information > Members** or **Subgroup information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group or subgroup. +1. On the left sidebar, **Manage > Members**. 1. Select **Export as CSV**. 1. After the CSV file has been generated, it is emailed as an attachment to the user that requested it. @@ -496,8 +496,8 @@ Changes to [group wikis](../project/wiki/group.md) do not appear in group activi You can view the most recent actions taken in a group, either in your browser or in an RSS feed: -1. On the top bar, select **Main menu > Groups > View all groups** and find your group. -1. On the left sidebar, select **Group information > Activity**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Manage > Activity**. To view the activity feed in Atom format, select the **RSS** (**{rss}**) icon. diff --git a/doc/user/group/moderate_users.md b/doc/user/group/moderate_users.md index 4ec86893524..1dde36c5c70 100644 --- a/doc/user/group/moderate_users.md +++ b/doc/user/group/moderate_users.md @@ -26,7 +26,7 @@ Prerequisites: To unban a user: 1. Go to the top-level group. -1. On the left sidebar, select **Group information > Members**. +1. On the left sidebar, select **Manage > Members**. 1. Select the **Banned** tab. 1. For the account you want to unban, select **Unban**. @@ -43,6 +43,6 @@ Prerequisites: To manually ban a user: 1. Go to the top-level group. -1. On the left sidebar, select **Group information > Members**. +1. On the left sidebar, select **Manage > Members**. 1. Next to the member you want to ban, select the vertical ellipsis (**{ellipsis_v}**). 1. From the dropdown list, select **Ban member**. diff --git a/doc/user/group/subgroups/index.md b/doc/user/group/subgroups/index.md index 4134c541496..12d92196c50 100644 --- a/doc/user/group/subgroups/index.md +++ b/doc/user/group/subgroups/index.md @@ -160,8 +160,8 @@ Group permissions for a member can be changed only by: To see if a member has inherited the permissions from a parent group: -1. On the top bar, select **Main menu > Groups** and find the group. -1. Select **Group information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Manage > Members**. Members list for an example subgroup _Four_: diff --git a/doc/user/project/integrations/index.md b/doc/user/project/integrations/index.md index 3bdb6ada00e..abc274d814d 100644 --- a/doc/user/project/integrations/index.md +++ b/doc/user/project/integrations/index.md @@ -81,6 +81,7 @@ You can configure the following integrations. | [Slack notifications](slack.md) | Send notifications about project events to Slack. | **{dotted-circle}** No | | [Slack slash commands](slack_slash_commands.md) | Enable slash commands in a workspace. | **{dotted-circle}** No | | [Squash TM](squash_tm.md) | Update Squash TM requirements when GitLab issues are modified. | **{check-circle}** Yes | +| [Telegram](telegram.md) | Send notifications about project events to Telegram. | **{dotted-circle}** No | | [Unify Circuit](unify_circuit.md) | Send notifications about project events to Unify Circuit. | **{dotted-circle}** No | | [Webex Teams](webex_teams.md) | Receive events notifications. | **{dotted-circle}** No | | [YouTrack](youtrack.md) | Use YouTrack as the issue tracker. | **{dotted-circle}** No | diff --git a/doc/user/project/integrations/telegram.md b/doc/user/project/integrations/telegram.md new file mode 100644 index 00000000000..d2e402d0bd0 --- /dev/null +++ b/doc/user/project/integrations/telegram.md @@ -0,0 +1,55 @@ +--- +stage: Manage +group: Import and Integrate +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Telegram **(FREE)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122879) in GitLab 16.1. + +You can configure GitLab to send notifications to a Telegram chat or channel. +To set up the Telegram integration, you must: + +1. [Create a Telegram bot](#create-a-telegram-bot). +1. [Configure the Telegram bot](#configure-the-telegram-bot). +1. [Set up the Telegram integration in GitLab](#set-up-the-telegram-integration-in-gitlab). + +## Create a Telegram bot + +To create a bot in Telegram: + +1. Start a new chat with `@BotFather`. +1. [Create a new bot](https://core.telegram.org/bots/features#creating-a-new-bot) as described in the Telegram documentation. + +When you create a bot, `BotFather` provides you with an API token. Keep this token secure as you need it to authenticate the bot in Telegram. + +## Configure the Telegram bot + +To configure the bot in Telegram: + +1. Add the bot as an administrator to a new or existing channel. +1. Assign the bot `Post Messages` rights to receive events. +1. Create an identifier for the channel. + +## Set up the Telegram integration in GitLab + +After you invite the bot to a Telegram channel, you can configure GitLab to send notifications: + +1. To enable the integration: + - **For your group or project:** + 1. On the top bar, select **Main menu** and find your group or project. + 1. on the left sidebar, select **Settings > Integrations**. + - **For your instance:** + 1. On the top bar, select **Main menu > Admin**. + 1. On the left sidebar, select **Settings > Integrations**. +1. Select **Telegram**. +1. In **Enable integration**, select the **Active** checkbox. +1. In **New token**, [paste the token value from the Telegram bot](#create-a-telegram-bot). +1. In the **Trigger** section, select the checkboxes for the GitLab events you want to receive in Telegram. +1. In **Channel identifier**, [paste the channel identifier from the Telegram channel](#configure-the-telegram-bot). + - To get a private channel ID, use the [`getUpdates`](https://core.telegram.org/bots/api#getupdates) method. +1. Optional. Select **Test settings**. +1. Select **Save changes**. + +The Telegram channel can now receive all selected GitLab events. diff --git a/doc/user/project/integrations/webhook_events.md b/doc/user/project/integrations/webhook_events.md index cdbea599a3f..abcbf6009af 100644 --- a/doc/user/project/integrations/webhook_events.md +++ b/doc/user/project/integrations/webhook_events.md @@ -1143,7 +1143,8 @@ Payload example: "key": "NESTOR_PROD_ENVIRONMENT", "value": "us-west-1" } - ] + ], + "url": "http://example.com/gitlab-org/gitlab-test/-/pipelines/31" }, "merge_request": { "id": 1, diff --git a/doc/user/project/repository/code_suggestions.md b/doc/user/project/repository/code_suggestions.md index d99191b3b19..8526f032941 100644 --- a/doc/user/project/repository/code_suggestions.md +++ b/doc/user/project/repository/code_suggestions.md @@ -183,8 +183,10 @@ Code Suggestions do not prevent you from writing code in your IDE. ### Internet connectivity -Code Suggestions only work when you have internet connectivity and can access GitLab.com. -Code Suggestions are not available for self-managed customers, nor customers operating within an offline environment. +To use Code Suggestions: + +- On GitLab.com, you must have an internet connection and be able to access GitLab. +- In GitLab 16.1 and later, on self-managed GitLab, you must have an internet connection. Code Suggestions does not work with offline environments. ### Model accuracy and quality |