diff options
Diffstat (limited to 'doc/user/profile')
-rw-r--r-- | doc/user/profile/account/create_accounts.md | 12 | ||||
-rw-r--r-- | doc/user/profile/account/delete_account.md | 6 | ||||
-rw-r--r-- | doc/user/profile/account/two_factor_authentication.md | 4 | ||||
-rw-r--r-- | doc/user/profile/achievements.md | 2 | ||||
-rw-r--r-- | doc/user/profile/active_sessions.md | 3 | ||||
-rw-r--r-- | doc/user/profile/comment_templates.md | 3 | ||||
-rw-r--r-- | doc/user/profile/contributions_calendar.md | 3 | ||||
-rw-r--r-- | doc/user/profile/index.md | 12 | ||||
-rw-r--r-- | doc/user/profile/notifications.md | 6 | ||||
-rw-r--r-- | doc/user/profile/personal_access_tokens.md | 58 | ||||
-rw-r--r-- | doc/user/profile/preferences.md | 25 | ||||
-rw-r--r-- | doc/user/profile/service_accounts.md | 7 | ||||
-rw-r--r-- | doc/user/profile/user_passwords.md | 2 |
13 files changed, 70 insertions, 73 deletions
diff --git a/doc/user/profile/account/create_accounts.md b/doc/user/profile/account/create_accounts.md index 2166b40b575..6c78152fa70 100644 --- a/doc/user/profile/account/create_accounts.md +++ b/doc/user/profile/account/create_accounts.md @@ -1,8 +1,7 @@ --- -type: reference stage: Govern group: Authentication -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Creating users **(FREE SELF)** @@ -16,9 +15,9 @@ You can create users: ## Create users on sign-in page -Prerequisite: +Prerequisites: -- [Sign-up must be enabled](../../admin_area/settings/sign_up_restrictions.md). +- [Sign-up must be enabled](../../../administration/settings/sign_up_restrictions.md). Users can create their own accounts by either: @@ -27,14 +26,13 @@ Users can create their own accounts by either: ## Create users in Admin Area -Prerequisite: +Prerequisites: - You must have administrator access to the instance. To create a user manually: -1. On the left sidebar, select **Search or go to**. -1. Select **Admin Area**. +1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **Overview > Users**. 1. Select **New user**. 1. Complete the required fields, such as name, username, and email. diff --git a/doc/user/profile/account/delete_account.md b/doc/user/profile/account/delete_account.md index 70c12cbcf00..a3df0aa5460 100644 --- a/doc/user/profile/account/delete_account.md +++ b/doc/user/profile/account/delete_account.md @@ -1,8 +1,7 @@ --- -type: howto stage: Govern group: Authentication -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Deleting a user account **(FREE ALL)** @@ -36,8 +35,7 @@ On GitLab.com, there is a seven day delay between a user deleting their own acco As an administrator, to delete a user account: -1. On the left sidebar, select **Search or go to**. -1. Select **Admin Area**. +1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **Overview > Users**. 1. Select a user. 1. Under the **Account** tab, select: diff --git a/doc/user/profile/account/two_factor_authentication.md b/doc/user/profile/account/two_factor_authentication.md index d26f2193124..376fde66cf0 100644 --- a/doc/user/profile/account/two_factor_authentication.md +++ b/doc/user/profile/account/two_factor_authentication.md @@ -1,7 +1,7 @@ --- stage: Govern group: Authentication -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Two-factor authentication **(FREE ALL)** @@ -521,7 +521,7 @@ Instead you can authenticate: - Using a [personal access token](../personal_access_tokens.md) (PAT): - For Git requests over HTTP(S), a PAT with `read_repository` or `write_repository` scope is required. - - For [GitLab Container Registry](../../packages/container_registry/authenticate_with_container_registry.md) requests, a PAT + - For [GitLab container registry](../../packages/container_registry/authenticate_with_container_registry.md) requests, a PAT with `read_registry` or `write_registry` scope is required. - For [Dependency Proxy](../../packages/dependency_proxy/index.md#authenticate-with-the-dependency-proxy) requests, a PAT with `read_registry` and `write_registry` scopes is required. diff --git a/doc/user/profile/achievements.md b/doc/user/profile/achievements.md index c208bd554bf..0f03868de95 100644 --- a/doc/user/profile/achievements.md +++ b/doc/user/profile/achievements.md @@ -1,7 +1,7 @@ --- stage: Data Stores group: Tenant Scale -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Achievements **(FREE ALL EXPERIMENT)** diff --git a/doc/user/profile/active_sessions.md b/doc/user/profile/active_sessions.md index 5e8eb80a1aa..658134be9ad 100644 --- a/doc/user/profile/active_sessions.md +++ b/doc/user/profile/active_sessions.md @@ -1,8 +1,7 @@ --- stage: none group: unassigned -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 -type: howto +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Active sessions **(FREE ALL)** diff --git a/doc/user/profile/comment_templates.md b/doc/user/profile/comment_templates.md index 98fabdb0a35..126f0e1dc8c 100644 --- a/doc/user/profile/comment_templates.md +++ b/doc/user/profile/comment_templates.md @@ -1,8 +1,7 @@ --- stage: Create group: Code Review -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 -type: howto +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Comment templates **(FREE ALL)** diff --git a/doc/user/profile/contributions_calendar.md b/doc/user/profile/contributions_calendar.md index 37b2c1a26e6..ec1bb3f7771 100644 --- a/doc/user/profile/contributions_calendar.md +++ b/doc/user/profile/contributions_calendar.md @@ -1,8 +1,7 @@ --- stage: Data Stores group: Tenant Scale -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 -type: concepts, howto +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Contributions calendar **(FREE ALL)** diff --git a/doc/user/profile/index.md b/doc/user/profile/index.md index 64fa5d7b448..81e2f3d7a55 100644 --- a/doc/user/profile/index.md +++ b/doc/user/profile/index.md @@ -1,8 +1,7 @@ --- -type: index, howto stage: Govern group: Authentication -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # User account **(FREE ALL)** @@ -127,14 +126,15 @@ GitLab displays the contents of your README below your contribution graph. ### From an existing project To add the README from an existing project to your profile, -[update the path](../project/settings/index.md#rename-a-repository) of the project +[update the path](../project/working_with_projects.md#rename-a-repository) of the project to match your username. ## Add external accounts to your user profile page -> Mastodon user account [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132892) in 16.6 [with a flag](../feature_flags.md) named `mastodon_social_ui`. Disabled by default. This feature is in [Beta](../../policy/experiment-beta-support.md#beta). +> - Mastodon user account [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132892) in GitLab 16.6 [with a flag](../feature_flags.md) named `mastodon_social_ui`. Disabled by default. +> - Mastodon user account [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/428163) in GitLab 16.7. Feature flag `mastodon_social_ui` removed. -You can add links to certain other external accounts you might have, like Skype and Twitter. +You can add links to certain other external accounts you might have, like Skype and X (formerly Twitter). They can help other users connect with you on other platforms. To add links to other accounts: @@ -146,7 +146,7 @@ To add links to other accounts: - LinkedIn profile name. - Mastodon username. - Skype username. - - Twitter @username. + - X (formerly Twitter) @username. Your user ID or username must be 500 characters or less. 1. Select **Update profile settings**. diff --git a/doc/user/profile/notifications.md b/doc/user/profile/notifications.md index 8d34055d42c..c7b2de3ce7f 100644 --- a/doc/user/profile/notifications.md +++ b/doc/user/profile/notifications.md @@ -1,7 +1,7 @@ --- stage: Plan group: Project Management -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Notification emails **(FREE ALL)** @@ -101,7 +101,7 @@ To select a notification level for a group, use either of these methods: 1. On the left sidebar, select your avatar. 1. Select **Preferences**. 1. On the left sidebar, select **Notifications**. -1. Locate the project in the **Groups** section. +1. Locate the group in the **Groups** section. 1. Select the desired [notification level](#notification-levels). Or: @@ -120,7 +120,7 @@ You can use group notifications, for example, if you work freelance, and want to 1. On the left sidebar, select your avatar. 1. Select **Preferences**. 1. On the left sidebar, select **Notifications**. -1. Locate the project in the **Groups** section. +1. Locate the group in the **Groups** section. 1. Select the desired email address. ### Change level of project notifications diff --git a/doc/user/profile/personal_access_tokens.md b/doc/user/profile/personal_access_tokens.md index a953a878cc9..9d54381ef87 100644 --- a/doc/user/profile/personal_access_tokens.md +++ b/doc/user/profile/personal_access_tokens.md @@ -1,8 +1,7 @@ --- -type: concepts, howto stage: Govern group: Authentication -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Personal access tokens **(FREE ALL)** @@ -69,7 +68,7 @@ list of scopes. To do this, you can append a `name` parameter and a list of comm to the URL. For example: ```plaintext -https://gitlab.example.com/-/profile/personal_access_tokens?name=Example+Access+token&scopes=api,read_user,read_registry +https://gitlab.example.com/-/user_settings/personal_access_tokens?name=Example+Access+token&scopes=api,read_user,read_registry ``` WARNING: @@ -83,7 +82,8 @@ At any time, you can revoke a personal access token. 1. On the left sidebar, select your avatar. 1. Select **Edit profile**. 1. On the left sidebar, select **Access Tokens**. -1. In the **Active personal access tokens** area, next to the key, select **Revoke**. +1. In the **Active personal access tokens** area, select **Revoke** for the relevant token. +1. On the confirmation dialog, select **Revoke**. ## View the last time a token was used @@ -100,7 +100,8 @@ To view the last time a token was used: 1. On the left sidebar, select your avatar. 1. Select **Edit profile**. 1. On the left sidebar, select **Access Tokens**. -1. In the **Active personal access tokens** area, next to the key, view the **Last Used** date. +1. In the **Active personal access tokens** area, view the **Last Used** date for + the relevant token. ## Personal access token scopes @@ -110,23 +111,23 @@ To view the last time a token was used: A personal access token can perform actions based on the assigned scopes. -| Scope | Access | -|--------------------|--------| -| `api` | Grants complete read/write access to the API, including all groups and projects, the container registry, and the package registry. | -| `read_user` | Grants read-only access to the authenticated user's profile through the `/user` API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under [`/users`](../../api/users.md). | -| `read_api` | Grants read access to the API, including all groups and projects, the container registry, and the package registry. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28944) in GitLab 12.10.) | -| `read_repository` | Grants read-only access to repositories on private projects using Git-over-HTTP or the Repository Files API. | -| `write_repository` | Grants read-write access to repositories on private projects using Git-over-HTTP (not using the API). | -| `read_registry` | Grants read-only (pull) access to a [Container Registry](../packages/container_registry/index.md) images if a project is private and authorization is required. Available only when the Container Registry is enabled. | -| `write_registry` | Grants read-write (push) access to a [Container Registry](../packages/container_registry/index.md) images if a project is private and authorization is required. Available only when the Container Registry is enabled. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28958) in GitLab 12.10.) | -| `sudo` | Grants permission to perform API actions as any user in the system, when authenticated as an administrator. | -| `admin_mode` | Grants permission to perform API actions as an administrator, when Admin Mode is enabled. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107875) in GitLab 15.8.) | -| `create_runner` | Grants permission to create runners. | -| `ai_features` | Grants permission to perform API actions for GitLab Duo. | -| `k8s_proxy` | Grants permission to perform Kubernetes API calls using the agent for Kubernetes. | +| Scope | Access | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `api` | Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry. | +| `read_user` | Grants read-only access to the authenticated user's profile through the `/user` API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under [`/users`](../../api/users.md). | +| `read_api` | Grants read access to the API, including all groups and projects, the container registry, and the package registry. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28944) in GitLab 12.10.) | +| `read_repository` | Grants read-only access to repositories on private projects using Git-over-HTTP or the Repository Files API. | +| `write_repository` | Grants read-write access to repositories on private projects using Git-over-HTTP (not using the API). | +| `read_registry` | Grants read-only (pull) access to [container registry](../packages/container_registry/index.md) images if a project is private and authorization is required. Available only when the container registry is enabled. | +| `write_registry` | Grants read-write (push) access to [container registry](../packages/container_registry/index.md) images if a project is private and authorization is required. Available only when the container registry is enabled. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28958) in GitLab 12.10.) | +| `sudo` | Grants permission to perform API actions as any user in the system, when authenticated as an administrator. | +| `admin_mode` | Grants permission to perform API actions as an administrator, when Admin Mode is enabled. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107875) in GitLab 15.8.) | +| `create_runner` | Grants permission to create runners. | +| `ai_features` | Grants permission to perform API actions for GitLab Duo. This scope is designed to work with the GitLab Duo Plugin for JetBrains. For all other extensions, see scope requirements. | +| `k8s_proxy` | Grants permission to perform Kubernetes API calls using the agent for Kubernetes. | WARNING: -If you enabled [external authorization](../admin_area/settings/external_authorization.md), personal access tokens cannot access container or package registries. If you use personal access tokens to access these registries, this measure breaks this use of these tokens. Disable external authorization to use personal access tokens with container or package registries. +If you enabled [external authorization](../../administration/settings/external_authorization.md), personal access tokens cannot access container or package registries. If you use personal access tokens to access these registries, this measure breaks this use of these tokens. Disable external authorization to use personal access tokens with container or package registries. ## When personal access tokens expire @@ -141,33 +142,32 @@ Personal access tokens expire on the date you define, at midnight, 00:00 AM UTC. [maximum allowed lifetime for the token](../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens). If the maximum allowed lifetime is not set, the default expiry date is 365 days from the date of creation. -### Service Accounts +### Create a service account personal access token with no expiry date -You can [create a personal access token for a service account](../../api/groups.md#create-personal-access-token-for-service-account-user) with no expiry date. +You can [create a personal access token for a service account](../../api/groups.md#create-personal-access-token-for-service-account-user) with no expiry date. These personal access tokens never expire, unlike non-service account personal access tokens. NOTE: Allowing personal access tokens for service accounts to be created with no expiry date only affects tokens created after you change this setting. It does not affect existing tokens. #### GitLab.com -Prerequisite: +Prerequisites: - You must have the Owner role in the top-level group. 1. On the left sidebar, select **Search or go to** and find your group. -1. Select **Settings > Permissions and group features**. +1. Select **Settings > General > Permissions and group features**. 1. Clear the **Service account token expiration** checkbox. You can now create personal access tokens for a service account user with no expiry date. #### Self-managed GitLab -Prerequisite: +Prerequisites: - You must be an administrator for your self-managed instance. -1. On the left sidebar, select **Search or go to**. -1. Select **Admin Area**. +1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Clear the **Service account token expiration** checkbox. @@ -179,7 +179,7 @@ You can now create personal access tokens for a service account user with no exp You can create a predetermined personal access token as part of your tests or automation. -Prerequisite: +Prerequisites: - You need sufficient access to run a [Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session) @@ -219,7 +219,7 @@ sudo gitlab-rails runner "token = User.find_by_username('automation-bot').person You can programmatically revoke a personal access token as part of your tests or automation. -Prerequisite: +Prerequisites: - You need sufficient access to run a [Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session) for your GitLab instance. diff --git a/doc/user/profile/preferences.md b/doc/user/profile/preferences.md index 34f083e0b48..6cc5f7c5039 100644 --- a/doc/user/profile/preferences.md +++ b/doc/user/profile/preferences.md @@ -1,8 +1,7 @@ --- stage: none group: unassigned -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 -type: concepts, howto +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Profile preferences **(FREE ALL)** @@ -272,16 +271,20 @@ To use exact times on the GitLab UI: > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15206) in GitLab 16.6. -You can customize the format used to display times of activities on your group and project overview pages and user profiles. You can display times as: +You can customize the format used to display times of activities on your group and project overview pages and user +profiles. You can display times as: - 12 hour format. For example: `2:34 PM`. - 24 hour format. For example: `14:34`. +You can also follow your system's setting. + To customize the time format: 1. On the left sidebar, select your avatar. -1. Select **Preferences** > **Time preferences**. -1. In **Time format**, select either the **12-hour** or **24-hour** option. +1. Select **Preferences**. +1. Go to the **Time preferences** section. +1. Under **Time format**, select either the **System**, **12-hour**, or **24-hour** option. 1. Select **Save changes**. ## User identities in CI job JSON web tokens @@ -315,13 +318,15 @@ To access your **Followers** and **Following** tabs: - On the left sidebar, select your avatar > select your name or username. - Select **Followers** or **Following**. -## Enable Code Suggestions +## Enable Code Suggestions **(FREE SAAS)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1 as [Beta](../../policy/experiment-beta-support.md#beta). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1 as [Beta](../../policy/experiment-beta-support.md#beta). +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139916) in GitLab 16.8. Available to a percentage of users. -Code Suggestions are disabled by default at the user account level. +A percentage of users can use Code Suggestions without any additional configuration. -To update this setting: +If the following options are available to you, it means you are **not** part of the percentage of users +and you must manually enable Code Suggestions for your account: 1. On the left sidebar, select your avatar. 1. Select **Preferences**. @@ -329,7 +334,7 @@ To update this setting: 1. Select **Save changes**. NOTE: -If Code Suggestions are disabled [for any groups that you belong to](../../user/group/manage.md#enable-code-suggestions), then you cannot enable them for yourself. (Your setting has no effect.) +If Code Suggestions are disabled [for any groups that you belong to](../../user/group/manage.md#enable-code-suggestions-for-a-group), then you cannot enable them for yourself. (Your setting has no effect.) ## Integrate your GitLab instance with third-party services diff --git a/doc/user/profile/service_accounts.md b/doc/user/profile/service_accounts.md index 8fa0067f150..3833d844d46 100644 --- a/doc/user/profile/service_accounts.md +++ b/doc/user/profile/service_accounts.md @@ -1,8 +1,7 @@ --- -type: index, howto stage: Govern group: Authentication -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Service accounts **(PREMIUM ALL)** @@ -40,7 +39,7 @@ How you create an account differs depending on whether you are on GitLab.com or ### GitLab.com -Prerequisite: +Prerequisites: - You must have the Owner role in a top-level group. @@ -62,7 +61,7 @@ Prerequisite: ### Self-managed GitLab -Prerequisite: +Prerequisites: - You must be an administrator for your self-managed instance. diff --git a/doc/user/profile/user_passwords.md b/doc/user/profile/user_passwords.md index 1b4fbd5fa53..97fd1081e05 100644 --- a/doc/user/profile/user_passwords.md +++ b/doc/user/profile/user_passwords.md @@ -1,7 +1,7 @@ --- stage: Govern group: Authentication -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 +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # User passwords **(FREE ALL)** |