diff options
Diffstat (limited to 'doc')
35 files changed, 48 insertions, 294 deletions
diff --git a/doc/administration/geo/index.md b/doc/administration/geo/index.md index 6609bbed5a6..811ac92de27 100644 --- a/doc/administration/geo/index.md +++ b/doc/administration/geo/index.md @@ -337,18 +337,9 @@ For answers to common questions, see the [Geo FAQ](replication/faq.md). ## Log files -Geo stores structured log messages in a `geo.log` file. For Linux package -installations, this file is at `/var/log/gitlab/gitlab-rails/geo.log`. +Geo stores structured log messages in a `geo.log` file. -This file contains information about when Geo attempts to sync repositories and files. Each line in the file contains a separate JSON entry that can be ingested into. For example, Elasticsearch or Splunk. - -For example: - -```json -{"severity":"INFO","time":"2017-08-06T05:40:16.104Z","message":"Repository update","project_id":1,"source":"repository","resync_repository":true,"resync_wiki":true,"class":"Gitlab::Geo::LogCursor::Daemon","cursor_delay_s":0.038} -``` - -This message shows that Geo detected that a repository update was needed for project `1`. +For more information on how to access and consume Geo logs, see the [Geo section in the log system documentation](../logs/index.md#geolog). ## Troubleshooting diff --git a/doc/administration/geo/replication/upgrading_the_geo_sites.md b/doc/administration/geo/replication/upgrading_the_geo_sites.md index aae35d45bde..4a72dcf0145 100644 --- a/doc/administration/geo/replication/upgrading_the_geo_sites.md +++ b/doc/administration/geo/replication/upgrading_the_geo_sites.md @@ -15,7 +15,7 @@ to Geo secondaries. This may result in a larger than expected downtime. Upgrading Geo sites involves performing: -1. [Version-specific upgrade steps](version_specific_upgrades.md), depending on the +1. [Version-specific upgrade steps](../../../update/index.md#version-specific-upgrading-instructions), depending on the version being upgraded to or from. 1. [General upgrade steps](#general-upgrade-steps), for all upgrades. diff --git a/doc/administration/geo/replication/version_specific_upgrades.md b/doc/administration/geo/replication/version_specific_upgrades.md deleted file mode 100644 index 13d00ced3cd..00000000000 --- a/doc/administration/geo/replication/version_specific_upgrades.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../../../update/index.md#version-specific-upgrading-instructions' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](../../../update/index.md#version-specific-upgrading-instructions). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/administration/gitaly/concurrency_limiting.md b/doc/administration/gitaly/concurrency_limiting.md index 321bb9efe20..2b1a2bbef64 100644 --- a/doc/administration/gitaly/concurrency_limiting.md +++ b/doc/administration/gitaly/concurrency_limiting.md @@ -18,7 +18,7 @@ Enabling limits on your environment should be done with caution and only in select circumstances, such as to protect against unexpected traffic. When reached, limits _do_ result in disconnects that negatively impact users. For consistent and stable performance, you should first explore other options such as -adjusting node specifications, and [reviewing large repositories](../../user/project/repository/managing_large_repositories.md) or workloads. +adjusting node specifications, and [reviewing large repositories](../../user/project/repository/monorepos/index.md) or workloads. ## Limit RPC concurrency @@ -30,7 +30,7 @@ When cloning or pulling repositories, various RPCs run in the background. In par These RPCs can consume a large amount of resources, which can have a significant impact in situations such as: - Unexpectedly high traffic. -- Running against [large repositories](../../user/project/repository/managing_large_repositories.md) that don't follow best practices. +- Running against [large repositories](../../user/project/repository/monorepos/index.md) that don't follow best practices. You can limit these processes from overwhelming your Gitaly server in these scenarios using the concurrency limits in the Gitaly configuration file. For example: @@ -94,7 +94,7 @@ number of in-flight pack-object processes per remote IP address. WARNING: Only enable these limits on your environment with caution and only in select circumstances, such as to protect against unexpected traffic. When reached, these limits disconnect users. For consistent and stable performance, you should first explore other options such as adjusting node specifications, and -[reviewing large repositories](../../user/project/repository/managing_large_repositories.md) or workloads. +[reviewing large repositories](../../user/project/repository/monorepos/index.md) or workloads. Example configuration: diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md index 829455283b0..2cdb4ea35fc 100644 --- a/doc/administration/gitaly/configure_gitaly.md +++ b/doc/administration/gitaly/configure_gitaly.md @@ -574,7 +574,7 @@ Enabling limits on your environment should be done with caution and only in select circumstances, such as to protect against unexpected traffic. When reached, limits _do_ result in disconnects that negatively impact users. For consistent and stable performance, you should first explore other options such as -adjusting node specifications, and [reviewing large repositories](../../user/project/repository/managing_large_repositories.md) or workloads. +adjusting node specifications, and [reviewing large repositories](../../user/project/repository/monorepos/index.md) or workloads. When enabling cgroups for memory, you should ensure that no swap is configured on the Gitaly nodes as processes may switch to using that instead of being terminated. This situation could lead to notably compromised diff --git a/doc/administration/repository_storage_types.md b/doc/administration/repository_storage_types.md deleted file mode 100644 index 844dc76b23d..00000000000 --- a/doc/administration/repository_storage_types.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -redirect_to: 'repository_storage_paths.md' -remove_date: '2023-11-29' ---- - -This document was moved to [another location](repository_storage_paths.md). - -<!-- This redirect file can be deleted after <2023-11-29>. --> diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md deleted file mode 100644 index 09f7b4c77fa..00000000000 --- a/doc/api/award_emoji.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'emoji_reactions.md' -remove_date: '2023-12-20' ---- - -This document was moved to [another location](emoji_reactions.md). - -<!-- This redirect file can be deleted after <2023-12-20>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/ci/large_repositories/index.md b/doc/ci/large_repositories/index.md deleted file mode 100644 index cef0554bf6c..00000000000 --- a/doc/ci/large_repositories/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../../user/project/repository/managing_large_repositories.md' -remove_date: '2023-11-30' ---- - -This document was moved to [another location](../../user/project/repository/managing_large_repositories.md). - -<!-- This redirect file can be deleted after <2023-11-30>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/ci/pipelines/pipeline_efficiency.md b/doc/ci/pipelines/pipeline_efficiency.md index 4a548c8c0af..07fc7c2dfd6 100644 --- a/doc/ci/pipelines/pipeline_efficiency.md +++ b/doc/ci/pipelines/pipeline_efficiency.md @@ -27,7 +27,7 @@ The easiest indicators to check for inefficient pipelines are the runtimes of th stages, and the total runtime of the pipeline itself. The total pipeline duration is heavily influenced by the: -- [Size of the repository](../../user/project/repository/managing_large_repositories.md) +- [Size of the repository](../../user/project/repository/monorepos/index.md) - Total number of stages and jobs. - Dependencies between jobs. - The ["critical path"](#directed-acyclic-graphs-dag-visualization), which represents diff --git a/doc/development/activitypub/actor.md b/doc/development/activitypub/actor.md deleted file mode 100644 index 1d10e421df7..00000000000 --- a/doc/development/activitypub/actor.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'actors/index.md' -remove_date: '2023-12-08' ---- - -This document was moved to [another location](actors/index.md). - -<!-- This redirect file can be deleted after <2023-12-08>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/ai_features.md b/doc/development/ai_features.md deleted file mode 100644 index a952d8f2804..00000000000 --- a/doc/development/ai_features.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'ai_features/index.md' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](ai_features/index.md). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/documentation/alpha_beta.md b/doc/development/documentation/alpha_beta.md deleted file mode 100644 index 4579c57b448..00000000000 --- a/doc/development/documentation/alpha_beta.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'experiment_beta.md' -remove_date: '2023-11-29' ---- - -This document was moved to [another location](experiment_beta.md). - -<!-- This redirect file can be deleted after <2023-11-29>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/documentation/feature_flags.md b/doc/development/documentation/feature_flags.md index 617691e8628..637b2d163e7 100644 --- a/doc/development/documentation/feature_flags.md +++ b/doc/development/documentation/feature_flags.md @@ -17,7 +17,7 @@ When the state of a feature flag changes, the developer who made the change Every feature introduced to the codebase, even if it's behind a disabled feature flag, must be documented. For more information, see -[the discussion that led to this decision](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47917#note_459984428). [Experiment or Beta](../../policy/experiment-beta-support.md) features are usually behind a feature flag, and must also be documented. For more information, see [Document Experiment or Beta features](alpha_beta.md). +[the discussion that led to this decision](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47917#note_459984428). [Experiment or Beta](../../policy/experiment-beta-support.md) features are usually behind a feature flag, and must also be documented. For more information, see [Document Experiment or Beta features](experiment_beta.md). When the feature is [implemented in multiple merge requests](../feature_flags/index.md#feature-flags-in-gitlab-development), discuss the plan with your technical writer. diff --git a/doc/development/fe_guide/design_anti_patterns.md b/doc/development/fe_guide/design_anti_patterns.md deleted file mode 100644 index e0d3a80d9c8..00000000000 --- a/doc/development/fe_guide/design_anti_patterns.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -redirect_to: 'design_patterns.md' -remove_date: '2023-12-07' ---- - -This document was moved to [another location](design_patterns.md). - -<!-- This redirect file can be deleted after <2023-12-07>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md b/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md index 2c53185a5db..9417861eee9 100644 --- a/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md +++ b/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md @@ -26,7 +26,7 @@ Each event is defined in a separate YAML file consisting of the following fields |------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `description` | yes | A description of the event. | | `category` | yes | Always InternalEventTracking (only different for legacy events). | -| `action` | yes | A unique name for the event. | +| `action` | yes | A unique name for the event. Use the format `<operation>_<target_of_operation>_<where/when>`. <br/><br/> Ex: `publish_go_module_to_the_registry_from_pipeline` <br/>`<operation> = publish`<br/>`<target> = go_module`<br/>`<when/where> = to_the_registry_from_pipeline`. | | `identifiers` | no | A list of identifiers sent with the event. Can be set to one or more of `project`, `user`, or `namespace`. | | `product_section` | yes | The [section](https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/sections.yml). | | `product_stage` | no | The [stage](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) for the event. | @@ -43,7 +43,7 @@ This is an example YAML file for an internal event: ```yaml description: A user visited a product analytics dashboard category: InternalEventTracking -action: user_visited_dashboard +action: visit_product_analytics_dashboard identifiers: - project - user diff --git a/doc/development/internal_analytics/internal_event_tracking/event_definition_guide.md b/doc/development/internal_analytics/internal_event_tracking/event_definition_guide.md deleted file mode 100644 index 8793e317cdc..00000000000 --- a/doc/development/internal_analytics/internal_event_tracking/event_definition_guide.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../internal_event_instrumentation/event_definition_guide.md' -remove_date: '2023-12-27' ---- - -This document was moved to [another location](../internal_event_instrumentation/event_definition_guide.md). - -<!-- This redirect file can be deleted after <2023-12-27>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/internal_analytics/internal_event_tracking/index.md b/doc/development/internal_analytics/internal_event_tracking/index.md deleted file mode 100644 index 03b539d2a03..00000000000 --- a/doc/development/internal_analytics/internal_event_tracking/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../internal_event_instrumentation/index.md' -remove_date: '2023-12-27' ---- - -This document was moved to [another location](../internal_event_instrumentation/index.md). - -<!-- This redirect file can be deleted after <2023-12-27>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/internal_analytics/internal_event_tracking/introduction.md b/doc/development/internal_analytics/internal_event_tracking/introduction.md deleted file mode 100644 index 3f769e7935e..00000000000 --- a/doc/development/internal_analytics/internal_event_tracking/introduction.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../internal_event_instrumentation/introduction.md' -remove_date: '2023-12-27' ---- - -This document was moved to [another location](../internal_event_instrumentation/introduction.md). - -<!-- This redirect file can be deleted after <2023-12-27>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/internal_analytics/internal_event_tracking/migration.md b/doc/development/internal_analytics/internal_event_tracking/migration.md deleted file mode 100644 index 9d78f544f4c..00000000000 --- a/doc/development/internal_analytics/internal_event_tracking/migration.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../internal_event_instrumentation/migration.md' -remove_date: '2023-12-27' ---- - -This document was moved to [another location](../internal_event_instrumentation/migration.md). - -<!-- This redirect file can be deleted after <2023-12-27>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/internal_analytics/internal_event_tracking/quick_start.md b/doc/development/internal_analytics/internal_event_tracking/quick_start.md deleted file mode 100644 index 4c378c4d7bb..00000000000 --- a/doc/development/internal_analytics/internal_event_tracking/quick_start.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../internal_event_instrumentation/quick_start.md' -remove_date: '2023-12-27' ---- - -This document was moved to [another location](../internal_event_instrumentation/quick_start.md). - -<!-- This redirect file can be deleted after <2023-12-27>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/internal_analytics/service_ping/review_guidelines.md b/doc/development/internal_analytics/service_ping/review_guidelines.md deleted file mode 100644 index 0ca7b084fc4..00000000000 --- a/doc/development/internal_analytics/service_ping/review_guidelines.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../review_guidelines.md' -remove_date: '2023-12-29' ---- - -This document was moved to [another location](../review_guidelines.md). - -<!-- This redirect file can be deleted after <2023-12-29>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/development/internal_analytics/snowplow/review_guidelines.md b/doc/development/internal_analytics/snowplow/review_guidelines.md deleted file mode 100644 index 0ca7b084fc4..00000000000 --- a/doc/development/internal_analytics/snowplow/review_guidelines.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../review_guidelines.md' -remove_date: '2023-12-29' ---- - -This document was moved to [another location](../review_guidelines.md). - -<!-- This redirect file can be deleted after <2023-12-29>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/index.md b/doc/index.md index 5fdb2386771..37200d94293 100644 --- a/doc/index.md +++ b/doc/index.md @@ -54,7 +54,7 @@ For more information about GitLab account management, see: | Topic | Description | |:-----------------------------------------------------------|:------------| | [User account](user/profile/index.md) | Manage your account. | -| [Authentication](topics/authentication/index.md) | Account security with two-factor authentication, set up your SSH keys, and deploy keys for secure access to your projects. | +| [Authentication](administration/auth/index.md) | Account security with two-factor authentication, set up your SSH keys, and deploy keys for secure access to your projects. | | [User settings](user/profile/index.md#access-your-user-settings) | Manage your user settings, two factor authentication, and more. | | [User permissions](user/permissions.md) | Learn what each role in a project can do. | diff --git a/doc/security/index.md b/doc/security/index.md index 8fd55fd08ff..01f227efbf9 100644 --- a/doc/security/index.md +++ b/doc/security/index.md @@ -27,6 +27,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w - [Maximum decompressed file size for imported archives](../administration/settings/import_and_export_settings.md#maximum-decompressed-file-size-for-imported-archives) - [Responding to security incidents](responding_to_security_incidents.md) -To harden your GitLab instance and minimize the risk of unwanted user account creation, consider access control features like [Sign up restrictions](../administration/settings/sign_up_restrictions.md) and [Authentication options](../topics/authentication/index.md). For more detailed information, refer to [Hardening](hardening.md). +To harden your GitLab instance and minimize the risk of unwanted user account creation, consider access control features like [Sign up restrictions](../administration/settings/sign_up_restrictions.md) and [Authentication options](../administration/auth/index.md). For more detailed information, refer to [Hardening](hardening.md). Self-managed GitLab customers and administrators are responsible for the security of their underlying hosts, and for keeping GitLab itself up to date. It is important to [regularly patch GitLab](../policy/maintenance.md), patch your operating system and its software, and harden your hosts in accordance with vendor guidance. diff --git a/doc/topics/authentication/index.md b/doc/topics/authentication/index.md deleted file mode 100644 index 0702e715d73..00000000000 --- a/doc/topics/authentication/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../../administration/auth/index.md' -remove_date: '2023-12-26' ---- - -This document was moved to [another location](../../administration/auth/index.md). - -<!-- This redirect file can be deleted after <2023-12-26>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/update/plan_your_upgrade.md b/doc/update/plan_your_upgrade.md index 00ee87ac96c..eda78402c7a 100644 --- a/doc/update/plan_your_upgrade.md +++ b/doc/update/plan_your_upgrade.md @@ -143,7 +143,7 @@ version prior to upgrading the application server. If you're using Geo: - Review [Geo upgrade documentation](../administration/geo/replication/upgrading_the_geo_sites.md). -- Read about the [Geo version-specific update instructions](../administration/geo/replication/version_specific_upgrades.md). +- Read about the [Geo version-specific update instructions](index.md#version-specific-upgrading-instructions). - Review Geo-specific steps when [upgrading the database](https://docs.gitlab.com/omnibus/settings/database.html#upgrading-a-geo-instance). - Create an upgrade and rollback plan for _each_ Geo site (primary and each secondary). diff --git a/doc/user/analytics/contributor_statistics.md b/doc/user/analytics/contributor_statistics.md deleted file mode 100644 index b6f195e22ad..00000000000 --- a/doc/user/analytics/contributor_statistics.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'contributor_analytics.md' -remove_date: '2023-03-06' ---- - -This document was moved to [another location](contributor_analytics.md). - -<!-- This redirect file can be deleted after <YYYY-MM-DD>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/award_emojis.md b/doc/user/award_emojis.md deleted file mode 100644 index 09f7b4c77fa..00000000000 --- a/doc/user/award_emojis.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'emoji_reactions.md' -remove_date: '2023-12-20' ---- - -This document was moved to [another location](emoji_reactions.md). - -<!-- This redirect file can be deleted after <2023-12-20>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/custom_roles.md b/doc/user/custom_roles.md index 99e8b8b5d52..07e14494ada 100644 --- a/doc/user/custom_roles.md +++ b/doc/user/custom_roles.md @@ -1,24 +1,16 @@ --- stage: Govern -group: Authentication +group: Authorization 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 --- # Custom roles **(ULTIMATE ALL)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106256) in GitLab 15.7 [with a flag](../administration/feature_flags.md) named `customizable_roles`. +> - [Custom roles feature introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106256) in GitLab 15.7 [with a flag](../administration/feature_flags.md) named `customizable_roles`. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110810) in GitLab 15.9. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114524) in GitLab 15.10. -> - The ability for a custom role to view a vulnerability report [introduced](https://gitlab.com/groups/gitlab-org/-/epics/10160) in GitLab 16.1 [with a flag](../administration/feature_flags.md) named `custom_roles_vulnerability`. -> - Ability to view a vulnerability report [enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123835) in GitLab 16.1. -> - [Feature flag `custom_roles_vulnerability` removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124049) in GitLab 16.2. > - Ability to create and remove a custom role with the UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393235) in GitLab 16.4. -> - Ability to manage group members [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17364) in GitLab 16.5. -> - Ability to manage project access tokens [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421778) in GitLab 16.5 [with a flag](../administration/feature_flags.md) named `manage_project_access_tokens`. -> - Ability to archive projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/425957) in GitLab 16.7. > - Ability to use the UI to add a user to your group with a custom role, change a user's custom role, or remove a custom role from a group member [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393239) in GitLab 16.7. -> - Ability to delete projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/425959) in GitLab 16.8. -> - Ability to manage group access tokens [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428353) in GitLab 16.8. Custom roles allow group Owners or instance administrators to create roles specific to the needs of their organization. @@ -28,6 +20,10 @@ For a demo of the custom roles feature, see [[Demo] Ultimate Guest can view code You can discuss individual custom role and permission requests in [issue 391760](https://gitlab.com/gitlab-org/gitlab/-/issues/391760). +## Available permissions + +For more information on available permissions, see [custom abilities](custom_roles/abilities.md). + ## Create a custom role Prerequisites: @@ -98,28 +94,6 @@ In **Settings > Roles and Permissions**, the list of all custom roles displays t To create a custom role, you can also [use the API](../api/member_roles.md#add-a-member-role-to-a-group). -### Available permissions - -The following permissions are available. You can add these permissions in any combination -to a base role to create a custom role. - -Some permissions require having other permissions enabled first. For example, administration of vulnerabilities (`admin_vulnerability`) can only be enabled if reading vulnerabilities (`read_vulnerability`) is also enabled. - -These requirements are documented in the `Required permission` column in the following table. - -| Permission | Version | Required permission | Description | -| ------------------------------- | -----------------------| -------------------- | ----------- | -| `read_code` | GitLab 15.7 and later | Not applicable | View project code. Does not include the ability to pull code. | -| `read_vulnerability` | GitLab 16.1 and later | Not applicable | View [vulnerability reports](application_security/vulnerability_report/index.md). | -| `admin_vulnerability` | GitLab 16.1 and later | `read_vulnerability` | Change the [status of vulnerabilities](application_security/vulnerabilities/index.md#vulnerability-status-values). | -| `read_dependency` | GitLab 16.3 and later | Not applicable | View [project dependencies](application_security/dependency_list/index.md). | -| `admin_merge_request` | GitLab 16.4 and later | Not applicable | View and approve [merge requests](project/merge_requests/index.md), revoke merge request approval, and view the associated merge request code. <br> Does not allow users to view or change merge request approval rules. | -| `manage_project_access_tokens` | GitLab 16.5 and later | Not applicable | Create, delete, and list [project access tokens](project/settings/project_access_tokens.md). | -| `admin_group_member` | GitLab 16.5 and later | Not applicable | Add or remove [group members](group/manage.md). | -| `archive_project` | GitLab 16.7 and later | Not applicable | [Archive and unarchive projects](project/settings/migrate_projects.md#archive-a-project). | -| `remove_project` | GitLab 16.8 and later | Not applicable | [Delete projects](project/working_with_projects.md#delete-a-project). | -| `manage_group_access_tokens` | GitLab 16.8 and later | Not applicable | [Create, delete, and list group access tokens](group/settings/group_access_tokens.md). | - ## Billing and seat usage When you enable a custom role for a user with the Guest role, that user has diff --git a/doc/user/custom_roles/abilities.md b/doc/user/custom_roles/abilities.md new file mode 100644 index 00000000000..3e74fcc5a7d --- /dev/null +++ b/doc/user/custom_roles/abilities.md @@ -0,0 +1,27 @@ +--- +stage: Govern +group: Authorization +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 +--- + +# Available custom abilities + +The following abilities are available. You can add these abilities in any combination +to a base role to create a custom role. + +Some abilities require having other abilities enabled first. For example, administration of vulnerabilities (`admin_vulnerability`) can only be enabled if reading vulnerabilities (`read_vulnerability`) is also enabled. + +These requirements are documented in the `Required ability` column in the following table. + +| Ability | Version | Required ability | Description | +| ------------------------------- | -----------------------| -------------------- | ----------- | +| `read_code` | [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106256) in GitLab 15.7 [with a flag](../../administration/feature_flags.md) named `customizable_roles`. [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114524) in GitLab 15.10.| Not applicable | View project code. Does not include the ability to pull code. | +| `read_vulnerability` | [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10160) in GitLab 16.1 [with a flag](../../administration/feature_flags.md) named `custom_roles_vulnerability`. [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124049) in GitLab 16.2. | Not applicable | View [vulnerability reports](../application_security/vulnerability_report/index.md). | +| `admin_vulnerability` | [Introduced in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/412536). | `read_vulnerability` | Change the [status of vulnerabilities](../application_security/vulnerabilities/index.md#vulnerability-status-values). | +| `read_dependency` | [Introduced in GitLab 16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/415255). | Not applicable | View [project dependencies](../application_security/dependency_list/index.md). | +| `admin_merge_request` | [Introduced in GitLab 16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/412708). | Not applicable | View and approve [merge requests](../project/merge_requests/index.md), revoke merge request approval, and view the associated merge request code. <br> Does not allow users to view or change merge request approval rules. | +| `manage_project_access_tokens` | [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421778) in GitLab 16.5 [with a flag](../../administration/feature_flags.md) named `manage_project_access_tokens` | Not applicable | Create, delete, and list [project access tokens](../project/settings/project_access_tokens.md). | +| `admin_group_member` | [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17364) in GitLab 16.5 | Not applicable | Add or remove [group members](../group/manage.md). | +| `archive_project` | [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/425957) in GitLab 16.7 | Not applicable | [Archive and unarchive projects](../project/settings/migrate_projects.md#archive-a-project). | +| `remove_project` | [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/425959) in GitLab 16.8 | Not applicable | [Delete projects](../project/working_with_projects.md#delete-a-project). | +| `manage_group_access_tokens` | [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428353) in GitLab 16.8 | Not applicable | [Create, delete, and list group access tokens](../group/settings/group_access_tokens.md). | diff --git a/doc/user/profile/index.md b/doc/user/profile/index.md index 81e2f3d7a55..b903e422a59 100644 --- a/doc/user/profile/index.md +++ b/doc/user/profile/index.md @@ -425,7 +425,7 @@ a session if the browser is closed or the existing session expires. ## Related topics - [Create users](account/create_accounts.md) -- [Sign in to your GitLab account](../../topics/authentication/index.md) +- [Sign in to your GitLab account](../../administration/auth/index.md) - [Change your password](user_passwords.md) - Receive emails for: - [Sign-ins from unknown IP addresses or devices](notifications.md#notifications-for-unknown-sign-ins) diff --git a/doc/user/project/repository/gpg_signed_commits/index.md b/doc/user/project/repository/gpg_signed_commits/index.md deleted file mode 100644 index 592041ef4e2..00000000000 --- a/doc/user/project/repository/gpg_signed_commits/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../signed_commits/gpg.md' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](../signed_commits/gpg.md). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/project/repository/managing_large_repositories.md b/doc/user/project/repository/managing_large_repositories.md deleted file mode 100644 index 1fedd8da20c..00000000000 --- a/doc/user/project/repository/managing_large_repositories.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'monorepos/index.md' -remove_date: '2023-12-17' ---- - -This document was moved to [another location](monorepos/index.md). - -<!-- This redirect file can be deleted after <2023-12-17>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/project/repository/ssh_signed_commits/index.md b/doc/user/project/repository/ssh_signed_commits/index.md deleted file mode 100644 index 89e3d811dba..00000000000 --- a/doc/user/project/repository/ssh_signed_commits/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../signed_commits/ssh.md' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](../signed_commits/ssh.md). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/project/repository/x509_signed_commits/index.md b/doc/user/project/repository/x509_signed_commits/index.md deleted file mode 100644 index ae418581820..00000000000 --- a/doc/user/project/repository/x509_signed_commits/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../signed_commits/x509.md' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](../signed_commits/x509.md). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> |