From eb4ebf62e45b7032f2ca3cc781f0e94a24dc1bc7 Mon Sep 17 00:00:00 2001 From: Ashraf Khamis <akhamis@gitlab.com> Date: Fri, 7 Feb 2025 14:36:10 +0000 Subject: [PATCH] Rename index files for Hugo migration Update crosslinks from docs and UI Changelog: changed --- .../usage_quotas/storage/constants.js | 2 +- .../application_settings/_pages.html.haml | 10 ++-- .../_silent_mode_settings_form.html.haml | 2 +- app/views/admin/dashboard/index.html.haml | 2 +- .../shared/_silent_mode_banner.html.haml | 2 +- .../shared/packages/_no_packages.html.haml | 2 +- .../{index.md => _index.md} | 0 doc/administration/auth/_index.md | 2 +- .../auth/ldap/{index.md => _index.md} | 0 .../auth/ldap/google_secure_ldap.md | 2 +- .../auth/ldap/ldap-troubleshooting.md | 16 ++--- .../auth/ldap/ldap_synchronization.md | 8 +-- doc/administration/backup_restore/_index.md | 2 +- .../backup_restore/backup_cli.md | 2 +- .../backup_restore/backup_gitlab.md | 4 +- .../backup_restore/migrate_to_new_server.md | 6 +- doc/administration/cicd/job_artifacts.md | 2 +- doc/administration/configure.md | 6 +- doc/administration/dedicated/architecture.md | 2 +- doc/administration/encrypted_configuration.md | 2 +- .../geo/{index.md => _index.md} | 6 +- .../geo/disaster_recovery/_index.md | 6 +- .../geo/disaster_recovery/planned_failover.md | 2 +- .../runbooks/planned_failover_multi_node.md | 4 +- .../geo/replication/configuration.md | 10 ++-- .../geo/replication/datatypes.md | 4 +- doc/administration/geo/replication/faq.md | 2 +- .../geo/replication/multiple_servers.md | 2 +- .../geo/replication/security_review.md | 2 +- .../replication/selective_synchronization.md | 2 +- .../troubleshooting/{index.md => _index.md} | 0 .../troubleshooting/client_http.md | 2 +- .../geo/replication/troubleshooting/common.md | 6 +- .../synchronization_verification.md | 2 +- .../replication/upgrading_the_geo_sites.md | 4 +- .../geo/secondary_proxy/_index.md | 2 +- doc/administration/geo/setup/_index.md | 6 +- doc/administration/geo/setup/database.md | 4 +- .../geo/setup/external_database.md | 4 +- .../two_single_node_external_services.md | 10 ++-- .../geo/setup/two_single_node_sites.md | 8 +-- doc/administration/geo_sites.md | 2 +- doc/administration/gitaly/_index.md | 10 ++-- .../gitaly/gitaly_geo_capabilities.md | 2 +- doc/administration/gitaly/praefect.md | 2 +- doc/administration/instance_limits.md | 4 +- doc/administration/license.md | 2 +- doc/administration/load_balancer.md | 4 +- doc/administration/logs/log_parsing.md | 2 +- .../maintenance_mode/{index.md => _index.md} | 2 +- doc/administration/moderate_users.md | 2 +- doc/administration/object_storage.md | 16 ++--- .../operations/fast_ssh_key_lookup.md | 2 +- .../operations/moving_repositories.md | 2 +- .../postgresql_versions.md | 4 +- .../packages/{index.md => _index.md} | 0 .../pages/{index.md => _index.md} | 4 +- doc/administration/pages/source.md | 2 +- doc/administration/pages/troubleshooting.md | 14 ++--- doc/administration/postgresql/upgrading_os.md | 4 +- doc/administration/raketasks/ldap.md | 2 +- doc/administration/read_only_gitlab.md | 2 +- .../reference_architectures/10k_users.md | 4 +- .../reference_architectures/25k_users.md | 4 +- .../reference_architectures/2k_users.md | 4 +- .../reference_architectures/3k_users.md | 4 +- .../reference_architectures/50k_users.md | 4 +- .../reference_architectures/5k_users.md | 4 +- .../reference_architectures/_index.md | 8 +-- doc/administration/server_hooks.md | 2 +- .../settings/sign_up_restrictions.md | 4 +- .../settings/usage_statistics.md | 2 +- doc/administration/sidekiq/_index.md | 2 +- .../silent_mode/{index.md => _index.md} | 0 doc/administration/troubleshooting/_index.md | 2 +- .../troubleshooting/postgresql.md | 2 +- .../wikis/{index.md => _index.md} | 0 .../audit_event_streaming_instances.md | 2 +- doc/api/packages.md | 2 +- doc/api/pages.md | 2 +- doc/api/pages_domains.md | 2 +- doc/api/settings.md | 2 +- doc/ci/jobs/job_artifacts.md | 4 +- doc/ci/yaml/_index.md | 2 +- doc/development/architecture.md | 4 +- doc/development/audit_event_guide/_index.md | 2 +- .../contributing/merge_request_workflow.md | 2 +- doc/development/ee_features.md | 2 +- doc/development/geo/proxying.md | 2 +- .../internal_analytics/service_ping/_index.md | 2 +- .../packages/new_format_development.md | 2 +- ...unning_tests_that_require_special_setup.md | 2 +- doc/install/aws/_index.md | 2 +- doc/install/google_cloud_platform/_index.md | 2 +- doc/install/installation.md | 2 +- doc/install/next_steps.md | 4 +- doc/install/postgresql_extensions.md | 2 +- doc/install/requirements.md | 6 +- doc/integration/kerberos.md | 4 +- doc/integration/omniauth.md | 2 +- doc/integration/saml.md | 2 +- doc/raketasks/_index.md | 2 +- doc/security/_index.md | 2 +- doc/security/hardening_nist_800_53.md | 10 ++-- doc/security/rate_limits.md | 2 +- .../responding_to_security_incidents.md | 2 +- .../cloud/aws/gitlab_aws_integration.md | 2 +- doc/subscriptions/bronze_starter.md | 2 +- doc/subscriptions/gitlab_dedicated/_index.md | 2 +- doc/subscriptions/self_managed/_index.md | 4 +- doc/update/_index.md | 4 +- doc/update/plan_your_upgrade.md | 2 +- doc/update/versions/gitlab_15_changes.md | 60 +++++++++---------- doc/update/versions/gitlab_16_changes.md | 14 ++--- doc/user/asciidoc.md | 2 +- doc/user/compliance/audit_event_streaming.md | 2 +- doc/user/compliance/audit_event_types.md | 2 +- doc/user/gitlab_com/_index.md | 2 +- doc/user/gitlab_duo/setup.md | 2 +- doc/user/gitlab_duo_chat/turn_on_off.md | 2 +- doc/user/group/access_and_permissions.md | 2 +- doc/user/markdown.md | 2 +- .../dependency_proxy/index.md | 2 +- doc/user/packages/package_registry/index.md | 2 +- .../terraform_module_registry/index.md | 2 +- doc/user/profile/account/create_accounts.md | 2 +- ...o_factor_authentication_troubleshooting.md | 2 +- .../integrations/webhooks_troubleshooting.md | 2 +- .../index.md | 6 +- .../lets_encrypt_integration.md | 4 +- doc/user/project/pages/index.md | 6 +- doc/user/project/pages/introduction.md | 2 +- .../project/pages/pages_access_control.md | 6 +- doc/user/project/repository/mirror/index.md | 2 +- doc/user/project/repository/mirror/pull.md | 2 +- doc/user/project/repository/mirror/push.md | 2 +- .../repository/mirror/troubleshooting.md | 2 +- doc/user/project/use_project_as_go_package.md | 2 +- doc/user/project/wiki/group.md | 2 +- doc/user/project/wiki/index.md | 4 +- doc/user/project/working_with_projects.md | 2 +- .../javascripts/audit_events/constants.js | 2 +- .../javascripts/geo_replicable/constants.js | 2 +- .../assets/javascripts/geo_sites/constants.js | 6 +- .../_ldap_access_setting.html.haml | 2 +- .../_maintenance_mode_settings_form.html.haml | 2 +- .../groups/group_members/_ldap_sync.html.haml | 2 +- .../empty_states/_geo_replication.html.haml | 2 +- .../groups/_max_pages_size_setting.html.haml | 2 +- .../docs/templates/audit_event_types.md.erb | 2 +- 150 files changed, 276 insertions(+), 276 deletions(-) rename doc/administration/audit_event_streaming/{index.md => _index.md} (100%) rename doc/administration/auth/ldap/{index.md => _index.md} (100%) rename doc/administration/geo/{index.md => _index.md} (98%) rename doc/administration/geo/replication/troubleshooting/{index.md => _index.md} (100%) rename doc/administration/maintenance_mode/{index.md => _index.md} (97%) rename doc/administration/packages/{index.md => _index.md} (100%) rename doc/administration/pages/{index.md => _index.md} (99%) rename doc/administration/silent_mode/{index.md => _index.md} (100%) rename doc/administration/wikis/{index.md => _index.md} (100%) diff --git a/app/assets/javascripts/usage_quotas/storage/constants.js b/app/assets/javascripts/usage_quotas/storage/constants.js index d6092ee3b67a..a535486fcb30 100644 --- a/app/assets/javascripts/usage_quotas/storage/constants.js +++ b/app/assets/javascripts/usage_quotas/storage/constants.js @@ -17,7 +17,7 @@ export const storageTypeHelpPaths = { snippets: helpPagePath('user/snippets', { anchor: 'reduce-snippets-repository-size', }), - wiki: helpPagePath('administration/wikis/index.md', { + wiki: helpPagePath('administration/wikis/_index.md', { anchor: 'reduce-wiki-repository-size', }), }; diff --git a/app/views/admin/application_settings/_pages.html.haml b/app/views/admin/application_settings/_pages.html.haml index ccb4ca8ab986..a11c88512353 100644 --- a/app/views/admin/application_settings/_pages.html.haml +++ b/app/views/admin/application_settings/_pages.html.haml @@ -3,14 +3,14 @@ %fieldset .form-group - - pages_link_url = help_page_path('administration/pages/index.md', anchor: 'custom-domain-verification') + - pages_link_url = help_page_path('administration/pages/_index.md', anchor: 'custom-domain-verification') - pages_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: pages_link_url } = f.gitlab_ui_checkbox_component :pages_domain_verification_enabled, s_("AdminSettings|Require users to prove ownership of custom domains"), help_text: s_('AdminSettings|Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled. %{link_start}Learn more%{link_end}.').html_safe % { link_start: pages_link_start, link_end: '</a>'.html_safe } - if Gitlab.config.pages.access_control .form-group - - pages_link_url = help_page_path('administration/pages/index.md', anchor: 'disable-public-access-to-all-pages-sites') + - pages_link_url = help_page_path('administration/pages/_index.md', anchor: 'disable-public-access-to-all-pages-sites') - pages_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: pages_link_url } = f.gitlab_ui_checkbox_component :force_pages_access_control, s_("AdminSettings|Disable public access to Pages sites"), @@ -19,13 +19,13 @@ = f.label :max_pages_size, _('Maximum size of pages (MiB)'), class: 'label-bold' = f.number_field :max_pages_size, class: 'form-control gl-form-input' .form-text.gl-text-subtle - - link = link_to('', help_page_path('administration/pages/index.md', anchor: 'set-maximum-size-of-gitlab-pages-site-in-a-project'), target: '_blank', rel: 'noopener noreferrer') + - link = link_to('', help_page_path('administration/pages/_index.md', anchor: 'set-maximum-size-of-gitlab-pages-site-in-a-project'), target: '_blank', rel: 'noopener noreferrer') = safe_format(s_('AdminSettings|Set the maximum size of GitLab Pages per project (0 for unlimited). %{link_start}Learn more%{link_end}.'), tag_pair(link, :link_start, :link_end)) .form-group = f.label :max_pages_custom_domains_per_project, s_('AdminSettings|Maximum number of custom domains per project'), class: 'label-bold' = f.number_field :max_pages_custom_domains_per_project, class: 'form-control gl-form-input' .form-text.gl-text-subtle - - link = link_to('', help_page_path('administration/pages/index.md', anchor: 'set-maximum-number-of-gitlab-pages-custom-domains-for-a-project'), target: '_blank', rel: 'noopener noreferrer') + - link = link_to('', help_page_path('administration/pages/_index.md', anchor: 'set-maximum-number-of-gitlab-pages-custom-domains-for-a-project'), target: '_blank', rel: 'noopener noreferrer') = safe_format(s_('AdminSettings|Set the maximum number of GitLab Pages custom domains per project (0 for unlimited). %{link_start}Learn more%{link_end}.'), tag_pair(link, :link_start, :link_end)) .form-group = f.label :pages_extra_deployments_default_expiry_seconds, s_('AdminSettings|Default expiration time for parallel deployments (in seconds)'), class: 'label-bold' @@ -42,7 +42,7 @@ = f.label :lets_encrypt_notification_email, s_("AdminSettings|Let's Encrypt email"), class: 'label-bold' = f.text_field :lets_encrypt_notification_email, class: 'form-control gl-form-input' .form-text.gl-text-subtle - - link = link_to('', help_page_path('administration/pages/index.md', anchor: 'lets-encrypt-integration'), target: '_blank', rel: 'noopener noreferrer') + - link = link_to('', help_page_path('administration/pages/_index.md', anchor: 'lets-encrypt-integration'), target: '_blank', rel: 'noopener noreferrer') = safe_format(s_("AdminSettings|A Let's Encrypt account will be configured for this GitLab instance using this email address. You will receive emails to warn of expiring certificates. %{link_start}Learn more%{link_end}."), tag_pair(link, :link_start, :link_end)) .form-group - terms_of_service_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: lets_encrypt_terms_of_service_admin_application_settings_path } diff --git a/app/views/admin/application_settings/_silent_mode_settings_form.html.haml b/app/views/admin/application_settings/_silent_mode_settings_form.html.haml index cf8dd7653085..9a3bd1cd1c9e 100644 --- a/app/views/admin/application_settings/_silent_mode_settings_form.html.haml +++ b/app/views/admin/application_settings/_silent_mode_settings_form.html.haml @@ -3,6 +3,6 @@ expanded: expanded_by_default?) do |c| - c.with_description do = s_('SilentMode|Suppress outbound communication, such as emails, from GitLab.') - = link_to _('Learn more.'), help_page_path('administration/silent_mode/index.md'), target: '_blank', rel: 'noopener noreferrer' + = link_to _('Learn more.'), help_page_path('administration/silent_mode/_index.md'), target: '_blank', rel: 'noopener noreferrer' - c.with_body do #js-silent-mode-settings{ data: { "silent-mode-enabled" => @application_setting.silent_mode_enabled.to_s } } diff --git a/app/views/admin/dashboard/index.html.haml b/app/views/admin/dashboard/index.html.haml index 1c6482e0ee94..ea9440219adb 100644 --- a/app/views/admin/dashboard/index.html.haml +++ b/app/views/admin/dashboard/index.html.haml @@ -105,7 +105,7 @@ = feature_entry(_('LDAP'), enabled: Gitlab.config.ldap.enabled, - doc_href: help_page_path('administration/auth/ldap/index.md')) + doc_href: help_page_path('administration/auth/ldap/_index.md')) = feature_entry(_('Gravatar'), href: general_admin_application_settings_path(anchor: 'js-account-settings'), diff --git a/app/views/shared/_silent_mode_banner.html.haml b/app/views/shared/_silent_mode_banner.html.haml index 62d62fbbc697..fc2a60efdb41 100644 --- a/app/views/shared/_silent_mode_banner.html.haml +++ b/app/views/shared/_silent_mode_banner.html.haml @@ -6,4 +6,4 @@ dismissible: false, variant: :warning) do |c| - c.with_body do - = s_('SilentMode|All outbound communications are blocked. %{link_start}Learn more%{link_end}.').html_safe % { link_start: "<a href='#{help_page_path('administration/silent_mode/index.md')}' target='_blank' rel='noopener noreferrer'>".html_safe, link_end: '</a>'.html_safe } + = s_('SilentMode|All outbound communications are blocked. %{link_start}Learn more%{link_end}.').html_safe % { link_start: "<a href='#{help_page_path('administration/silent_mode/_index.md')}' target='_blank' rel='noopener noreferrer'>".html_safe, link_end: '</a>'.html_safe } diff --git a/app/views/shared/packages/_no_packages.html.haml b/app/views/shared/packages/_no_packages.html.haml index 923f300a5e9e..3b5374c1fb6c 100644 --- a/app/views/shared/packages/_no_packages.html.haml +++ b/app/views/shared/packages/_no_packages.html.haml @@ -3,5 +3,5 @@ .text-content %h4.text-center= _('There are no packages yet') %p - - link = link_to('', help_page_path('administration/packages/index.md'), target: '_blank', rel: 'noopener noreferrer') + - link = link_to('', help_page_path('administration/packages/_index.md'), target: '_blank', rel: 'noopener noreferrer') = safe_format(_('Learn how to %{no_packages_link_start}publish and share your packages%{no_packages_link_end} with GitLab.'), tag_pair(link, :no_packages_link_start, :no_packages_link_end)) diff --git a/doc/administration/audit_event_streaming/index.md b/doc/administration/audit_event_streaming/_index.md similarity index 100% rename from doc/administration/audit_event_streaming/index.md rename to doc/administration/audit_event_streaming/_index.md diff --git a/doc/administration/auth/_index.md b/doc/administration/auth/_index.md index 484554092840..b2a06a19c3d4 100644 --- a/doc/administration/auth/_index.md +++ b/doc/administration/auth/_index.md @@ -13,7 +13,7 @@ DETAILS: GitLab integrates with a number of [OmniAuth providers](../../integration/omniauth.md#supported-providers), and the following external authentication and authorization providers: -- [LDAP](ldap/index.md): Includes Active Directory, Apple Open Directory, Open LDAP, +- [LDAP](ldap/_index.md): Includes Active Directory, Apple Open Directory, Open LDAP, and 389 Server. - [Google Secure LDAP](ldap/google_secure_ldap.md) - [SAML for GitLab.com groups](../../user/group/saml_sso/index.md) diff --git a/doc/administration/auth/ldap/index.md b/doc/administration/auth/ldap/_index.md similarity index 100% rename from doc/administration/auth/ldap/index.md rename to doc/administration/auth/ldap/_index.md diff --git a/doc/administration/auth/ldap/google_secure_ldap.md b/doc/administration/auth/ldap/google_secure_ldap.md index be6bf7bf2331..27d582e37aa7 100644 --- a/doc/administration/auth/ldap/google_secure_ldap.md +++ b/doc/administration/auth/ldap/google_secure_ldap.md @@ -215,7 +215,7 @@ For self-compiled installations: ## Using encrypted credentials You can optionally store the `bind_dn` and `password` in a separate encrypted configuration file using the -[same steps as the regular LDAP integration](index.md#use-encrypted-credentials). +[same steps as the regular LDAP integration](_index.md#use-encrypted-credentials). <!-- ## Troubleshooting diff --git a/doc/administration/auth/ldap/ldap-troubleshooting.md b/doc/administration/auth/ldap/ldap-troubleshooting.md index 3193c3a97559..ad222647307a 100644 --- a/doc/administration/auth/ldap/ldap-troubleshooting.md +++ b/doc/administration/auth/ldap/ldap-troubleshooting.md @@ -118,8 +118,8 @@ established but GitLab doesn't show you LDAP users in the output, one of the following is most likely true: - The `bind_dn` user doesn't have enough permissions to traverse the user tree. -- The users don't fall under the [configured `base`](index.md#configure-ldap). -- The [configured `user_filter`](index.md#set-up-ldap-user-filter) blocks access to the users. +- The users don't fall under the [configured `base`](_index.md#configure-ldap). +- The [configured `user_filter`](_index.md#set-up-ldap-user-filter) blocks access to the users. In this case, you con confirm which of the above is true using [ldapsearch](#ldapsearch) with the existing LDAP configuration in your @@ -130,9 +130,9 @@ In this case, you con confirm which of the above is true using A user can have trouble signing in for any number of reasons. To get started, here are some questions to ask yourself: -- Does the user fall under the [configured `base`](index.md#configure-ldap) in +- Does the user fall under the [configured `base`](_index.md#configure-ldap) in LDAP? The user must fall under this `base` to sign in. -- Does the user pass through the [configured `user_filter`](index.md#set-up-ldap-user-filter)? +- Does the user pass through the [configured `user_filter`](_index.md#set-up-ldap-user-filter)? If one is not configured, this question can be ignored. If it is, then the user must also pass through this filter to be allowed to sign in. - Refer to our documentation on [debugging the `user_filter`](#debug-ldap-user-filter). @@ -249,7 +249,7 @@ To resolve this: #### Debug LDAP user filter [`ldapsearch`](#ldapsearch) allows you to test your configured -[user filter](index.md#set-up-ldap-user-filter) +[user filter](_index.md#set-up-ldap-user-filter) to confirm that it returns the users you expect it to return. ```shell @@ -778,7 +778,7 @@ end; nil ## Expired license causes errors with multiple LDAP servers -Using [multiple LDAP servers](index.md#use-multiple-ldap-servers) requires a valid license. An expired license can +Using [multiple LDAP servers](_index.md#use-multiple-ldap-servers) requires a valid license. An expired license can cause: - `502` errors in the web interface. @@ -887,7 +887,7 @@ identical to what's configured in the `gitlab.rb`. #### Use ldapsearch with `start_tls` encryption -The previous example performs an LDAP test in plaintext to port 389. If you are using [`start_tls` encryption](index.md#basic-configuration-settings), in +The previous example performs an LDAP test in plaintext to port 389. If you are using [`start_tls` encryption](_index.md#basic-configuration-settings), in the `ldapsearch` command include: - The `-Z` flag. @@ -905,7 +905,7 @@ ldapsearch -D "cn=admin,dc=ldap-testing,dc=example,dc=com" \ #### Use ldapsearch with `simple_tls` encryption -If you are using [`simple_tls` encryption](index.md#basic-configuration-settings) (usually on port 636), include the following in the `ldapsearch` command: +If you are using [`simple_tls` encryption](_index.md#basic-configuration-settings) (usually on port 636), include the following in the `ldapsearch` command: - The LDAP server FQDN with the `-H` flag and the port. - The full constructed URI. diff --git a/doc/administration/auth/ldap/ldap_synchronization.md b/doc/administration/auth/ldap/ldap_synchronization.md index a7ba19960d2b..a3074537a972 100644 --- a/doc/administration/auth/ldap/ldap_synchronization.md +++ b/doc/administration/auth/ldap/ldap_synchronization.md @@ -9,7 +9,7 @@ DETAILS: **Tier:** Premium, Ultimate **Offering:** GitLab Self-Managed -If you have [configured LDAP to work with GitLab](index.md), GitLab can automatically synchronize +If you have [configured LDAP to work with GitLab](_index.md), GitLab can automatically synchronize users and groups. LDAP synchronization updates user and group information for existing GitLab users that have an LDAP identity assigned. It does not create new GitLab users through LDAP. @@ -436,7 +436,7 @@ When global group memberships lock is enabled: To enable global group memberships lock: -1. [Configure LDAP](index.md#configure-ldap). +1. [Configure LDAP](_index.md#configure-ldap). 1. On the left sidebar, at the bottom, select **Admin**. 1. Select **Settings > General**. 1. Expand **Visibility and access controls**. @@ -448,7 +448,7 @@ By default, group members with the Owner role can manage [LDAP group synchroniza GitLab administrators can remove this permission from group Owners: -1. [Configure LDAP](index.md#configure-ldap). +1. [Configure LDAP](_index.md#configure-ldap). 1. On the left sidebar, at the bottom, select **Admin**. 1. Select **Settings > General**. 1. Expand **Visibility and access controls**. @@ -732,7 +732,7 @@ By default, GitLab runs a worker once per day at 01:30 a.m. server time to check and update GitLab users against LDAP. WARNING: -Do not run the sync process too frequently as this could lead to multiple syncs running concurrently. Most installations do not need to modify the sync schedule. For more information, see the [LDAP Security documentation](index.md#security). +Do not run the sync process too frequently as this could lead to multiple syncs running concurrently. Most installations do not need to modify the sync schedule. For more information, see the [LDAP Security documentation](_index.md#security). You can manually configure LDAP user sync times by setting the following configuration values, in cron format. If needed, you can diff --git a/doc/administration/backup_restore/_index.md b/doc/administration/backup_restore/_index.md index ead250d0de47..9ccd072a3e09 100644 --- a/doc/administration/backup_restore/_index.md +++ b/doc/administration/backup_restore/_index.md @@ -57,7 +57,7 @@ on how GitLab creates this archive, see [Backup archive process](backup_archive_ ## Related topics -- [Geo](../geo/index.md) +- [Geo](../geo/_index.md) - [Disaster Recovery (Geo)](../geo/disaster_recovery/_index.md) - [Migrating GitLab groups](../../user/group/import/index.md) - [Import and migrate projects](../../user/project/import/index.md) diff --git a/doc/administration/backup_restore/backup_cli.md b/doc/administration/backup_restore/backup_cli.md index 462398abedba..0330ab7c7eda 100644 --- a/doc/administration/backup_restore/backup_cli.md +++ b/doc/administration/backup_restore/backup_cli.md @@ -201,7 +201,7 @@ Changes to existing files during backup might cause issues on the GitLab instanc A workaround of this issue, is either to: -- Transition the GitLab instance into [Maintenance Mode](../maintenance_mode/index.md). +- Transition the GitLab instance into [Maintenance Mode](../maintenance_mode/_index.md). - Restrict traffic to the servers during backup to preserve instance resources. We're investigating an alternative to the copy strategy, see [issue 428520](https://gitlab.com/gitlab-org/gitlab/-/issues/428520). diff --git a/doc/administration/backup_restore/backup_gitlab.md b/doc/administration/backup_restore/backup_gitlab.md index bdde339ad642..9b9701f681eb 100644 --- a/doc/administration/backup_restore/backup_gitlab.md +++ b/doc/administration/backup_restore/backup_gitlab.md @@ -1394,7 +1394,7 @@ sudo -u git -H bundle exec rake gitlab:backup:create SKIP=repositories RAILS_ENV For manually backing up the Git repository data on disk, there are multiple possible strategies: - Use snapshots, such as the previous examples of Amazon EBS drive snapshots, or LVM snapshots + rsync. -- Use [GitLab Geo](../geo/index.md) and rely on the repository data on a Geo secondary site. +- Use [GitLab Geo](../geo/_index.md) and rely on the repository data on a Geo secondary site. - [Prevent writes and copy the Git repository data](#prevent-writes-and-copy-the-git-repository-data). - [Create an online backup by marking repositories as read-only (experimental)](#online-backup-through-marking-repositories-as-read-only-experimental). @@ -1407,7 +1407,7 @@ has a longer discussion explaining the potential problems. To prevent writes to the Git repository data, there are two possible approaches: -- Use [maintenance mode](../maintenance_mode/index.md) to place GitLab in a read-only state. +- Use [maintenance mode](../maintenance_mode/_index.md) to place GitLab in a read-only state. - Create explicit downtime by stopping all Gitaly services before backing up the repositories: ```shell diff --git a/doc/administration/backup_restore/migrate_to_new_server.md b/doc/administration/backup_restore/migrate_to_new_server.md index 0b2ce540c062..287f4a2e55e0 100644 --- a/doc/administration/backup_restore/migrate_to_new_server.md +++ b/doc/administration/backup_restore/migrate_to_new_server.md @@ -8,7 +8,7 @@ title: Migrate to a new server <!-- some details borrowed from GitLab.com move from Azure to GCP detailed at https://gitlab.com/gitlab-com/migration/-/blob/master/.gitlab/issue_templates/failover.md --> You can use GitLab backup and restore to migrate your instance to a new server. This section outlines a typical procedure for a GitLab deployment running on a single server. -If you're running GitLab Geo, an alternative option is [Geo disaster recovery for planned failover](../geo/disaster_recovery/planned_failover.md). You must make sure all sites meet the [Geo requirements](../geo/index.md#requirements-for-running-geo) before selecting Geo for the migration. +If you're running GitLab Geo, an alternative option is [Geo disaster recovery for planned failover](../geo/disaster_recovery/planned_failover.md). You must make sure all sites meet the [Geo requirements](../geo/_index.md#requirements-for-running-geo) before selecting Geo for the migration. WARNING: Avoid uncoordinated data processing by both the new and old servers, where multiple @@ -71,7 +71,7 @@ To prepare the new server: ## Prepare and transfer content from the old server 1. Ensure you have an up-to-date system-level backup or snapshot of the old server. -1. Enable [maintenance mode](../maintenance_mode/index.md), +1. Enable [maintenance mode](../maintenance_mode/_index.md), if supported by your GitLab edition. 1. Block new CI/CD jobs from starting: 1. Edit `/etc/gitlab/gitlab.rb`, and set the following: @@ -205,7 +205,7 @@ to the new environment. 1. While still under the Sidekiq dashboard, select **Cron** and then **Enable All** to re-enable periodic background jobs. 1. Test that read-only operations on the GitLab instance work as expected. For example, browse through project repository files, merge requests, and issues. -1. Disable [Maintenance Mode](../maintenance_mode/index.md), if previously enabled. +1. Disable [Maintenance Mode](../maintenance_mode/_index.md), if previously enabled. 1. Test that the GitLab instance is working as expected. 1. If applicable, re-enable [incoming email](../incoming_email.md) and test it is working as expected. 1. Update your DNS or load balancer to point at the new server. diff --git a/doc/administration/cicd/job_artifacts.md b/doc/administration/cicd/job_artifacts.md index e54277b7e2a2..901bbdb4733d 100644 --- a/doc/administration/cicd/job_artifacts.md +++ b/doc/administration/cicd/job_artifacts.md @@ -272,7 +272,7 @@ processing is done in a background worker and requires **no downtime**. ::EndTabs -1. If [Geo](../geo/index.md) is enabled, [reverify all job artifacts](../geo/replication/troubleshooting/synchronization_verification.md#reverify-all-components-or-any-ssf-data-type-which-supports-verification). +1. If [Geo](../geo/_index.md) is enabled, [reverify all job artifacts](../geo/replication/troubleshooting/synchronization_verification.md#reverify-all-components-or-any-ssf-data-type-which-supports-verification). In some cases, you need to run the [orphan artifact file cleanup Rake task](../../raketasks/cleanup.md#remove-orphan-artifact-files) to clean up orphaned artifacts. diff --git a/doc/administration/configure.md b/doc/administration/configure.md index 731cbd67b310..8580ed556f43 100644 --- a/doc/administration/configure.md +++ b/doc/administration/configure.md @@ -33,15 +33,15 @@ Customize and configure GitLab Self-Managed. - [Object storage](object_storage.md) - [Merge request diffs storage](merge_request_diffs.md) - [Static objects external storage](static_objects_external_storage.md) -- [Geo](geo/index.md) +- [Geo](geo/_index.md) - [Disaster recovery (Geo)](geo/disaster_recovery/_index.md) - [Agent server for Kubernetes](clusters/kas.md) - [Server hooks](server_hooks.md) - [Terraform state](terraform_state.md) - [Terraform limits](settings/terraform_limits.md) -- [Packages](packages/index.md) +- [Packages](packages/_index.md) - [Web terminals](integration/terminal.md) -- [Wikis](wikis/index.md) +- [Wikis](wikis/_index.md) - [Invalidate Markdown cache](invalidate_markdown_cache.md) - [Issue closing pattern](issue_closing_pattern.md) - [Snippets](snippets/_index.md) diff --git a/doc/administration/dedicated/architecture.md b/doc/administration/dedicated/architecture.md index 086fb6962d6d..eb14b5df04b0 100644 --- a/doc/administration/dedicated/architecture.md +++ b/doc/administration/dedicated/architecture.md @@ -47,7 +47,7 @@ GitLab Dedicated deploys Gitaly [in a sharded setup](../gitaly/_index.md#before- GitLab Dedicated leverages GitLab Geo for [disaster recovery](../../subscriptions/gitlab_dedicated/data_residency_and_high_availability.md#disaster-recovery). -Geo does not use an active-active failover configuration. For more information, see [Geo](../geo/index.md). +Geo does not use an active-active failover configuration. For more information, see [Geo](../geo/_index.md). ### AWS PrivateLink connection (optional) diff --git a/doc/administration/encrypted_configuration.md b/doc/administration/encrypted_configuration.md index 95a2f6220584..edece58ba723 100644 --- a/doc/administration/encrypted_configuration.md +++ b/doc/administration/encrypted_configuration.md @@ -12,7 +12,7 @@ DETAILS: GitLab can read settings for certain features from encrypted settings files. The supported features are: - [Incoming email `user` and `password`](incoming_email.md#use-encrypted-credentials). -- [LDAP `bind_dn` and `password`](auth/ldap/index.md#use-encrypted-credentials). +- [LDAP `bind_dn` and `password`](auth/ldap/_index.md#use-encrypted-credentials). - [Service Desk email `user` and `password`](../user/project/service_desk/configure.md#use-encrypted-credentials). - [SMTP `user_name` and `password`](raketasks/smtp.md#secrets). diff --git a/doc/administration/geo/index.md b/doc/administration/geo/_index.md similarity index 98% rename from doc/administration/geo/index.md rename to doc/administration/geo/_index.md index e0fdf41236c2..c6f6c06b8996 100644 --- a/doc/administration/geo/index.md +++ b/doc/administration/geo/_index.md @@ -17,7 +17,7 @@ Geo undergoes significant changes from release to release. Upgrades are supported and [documented](#upgrading-geo), but you should ensure that you're using the right version of the documentation for your installation. -To make sure you're using the right version of the documentation, go to [the Geo page on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/administration/geo/index.md) and choose the appropriate release from the **Switch branch/tag** dropdown list. For example, [`v15.7.6-ee`](https://gitlab.com/gitlab-org/gitlab/-/blob/v15.7.6-ee/doc/administration/geo/index.md). +To make sure you're using the right version of the documentation, go to [the Geo page on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/administration/geo/_index.md) and choose the appropriate release from the **Switch branch/tag** dropdown list. For example, [`v15.7.6-ee`](https://gitlab.com/gitlab-org/gitlab/-/blob/v15.7.6-ee/doc/administration/geo/_index.md). Fetching large repositories can take a long time for teams and runners located far from a single GitLab instance. @@ -285,7 +285,7 @@ These known issues reflect only the latest version of GitLab. If you are using a - When a single Git repository receives pushes at a high-enough rate, the secondary site's local copy can be perpetually out-of-date. This causes all Git fetches of that repository to be forwarded to the primary site. See [GitLab issue #455870](https://gitlab.com/gitlab-org/gitlab/-/issues/455870). - [Proxying](secondary_proxy/_index.md) is implemented only in the GitLab application in the Puma service or Web service, so other services do not benefit from this behavior. You should use a [separate URL](secondary_proxy/_index.md#set-up-a-separate-url-for-a-secondary-geo-site) to ensure requests are always sent to the primary. These services include: - GitLab container registry - [can be configured to use a separate domain](../packages/container_registry.md#configure-container-registry-under-its-own-domain), such as `registry.example.com`. Secondary site container registries are intended only for disaster recovery. Users should not be routed to them, especially not for pushes, because the data is not propagated to the primary site. - - GitLab Pages - should always use a separate domain, as part of [the prerequisites for running GitLab Pages](../pages/index.md#prerequisites). + - GitLab Pages - should always use a separate domain, as part of [the prerequisites for running GitLab Pages](../pages/_index.md#prerequisites). - With a [unified URL](secondary_proxy/_index.md#set-up-a-unified-url-for-geo-sites), Let's Encrypt can't generate certificates unless it can reach both IPs through the same domain. To use TLS certificates with Let's Encrypt, you can manually point the domain to one of the Geo sites, generate the certificate, then copy it to all other sites. - When a [secondary site uses a separate URL](secondary_proxy/_index.md#set-up-a-separate-url-for-a-secondary-geo-site) from the primary site, [signing in the secondary site using SAML](replication/single_sign_on.md#saml-with-separate-url-with-proxying-enabled) is only supported if the SAML Identity Provider (IdP) allows an application to be configured with multiple callback URLs. - Git clone and fetch requests with option `--depth` over SSH against a secondary site does not work and hangs indefinitely if the secondary site is not up to date at the time the request is initiated. This is due to problems related to translating Git SSH to Git https during proxying. For more information, see [issue 391980](https://gitlab.com/gitlab-org/gitlab/-/issues/391980). A new workflow that does not involve the aforementioned translation step is now available for Linux-packaged GitLab Geo secondary sites which can be enabled with a feature flag. For more details, see [comment in issue 454707](https://gitlab.com/gitlab-org/gitlab/-/issues/454707#note_2102067451). The fix for Cloud Native GitLab Geo secondary sites is tracked in [issue 5641](https://gitlab.com/gitlab-org/charts/gitlab/-/issues/5641). @@ -379,6 +379,6 @@ For answers to common questions, see the [Geo FAQ](replication/faq.md). ## Troubleshooting -- For Geo troubleshooting steps, see [Geo Troubleshooting](replication/troubleshooting/index.md). +- For Geo troubleshooting steps, see [Geo Troubleshooting](replication/troubleshooting/_index.md). - For Disaster Recovery troubleshooting steps, see [Troubleshooting Geo failover](disaster_recovery/failover_troubleshooting.md). diff --git a/doc/administration/geo/disaster_recovery/_index.md b/doc/administration/geo/disaster_recovery/_index.md index e70ee1ae22e5..36d9bec56ee5 100644 --- a/doc/administration/geo/disaster_recovery/_index.md +++ b/doc/administration/geo/disaster_recovery/_index.md @@ -10,7 +10,7 @@ DETAILS: **Offering:** GitLab Self-Managed Geo replicates your database, your Git repositories, and other assets. -Some [known issues](../index.md#known-issues) exist. +Some [known issues](../_index.md#known-issues) exist. WARNING: Multi-secondary configurations require the complete re-synchronization and re-configuration of all non-promoted secondaries and @@ -441,7 +441,7 @@ must disable the **primary** site: ### Step 2. Promote all **secondary** site nodes external to the cluster WARNING: -If the secondary site [has been paused](../../geo/index.md#pausing-and-resuming-replication), this performs +If the secondary site [has been paused](../../geo/_index.md#pausing-and-resuming-replication), this performs a point-in-time recovery to the last known state. Data that was created on the primary while the secondary was paused is lost. @@ -477,7 +477,7 @@ Data that was created on the primary while the secondary was paused is lost. | Name | Default value | Description | | ---- | ------------- | ------- | - | `ENABLE_SILENT_MODE` | `false` | If `true`, enables [Silent Mode](../../silent_mode/index.md) before promotion (GitLab 16.4 and later) | + | `ENABLE_SILENT_MODE` | `false` | If `true`, enables [Silent Mode](../../silent_mode/_index.md) before promotion (GitLab 16.4 and later) | ### Step 3. Promote the **secondary** cluster diff --git a/doc/administration/geo/disaster_recovery/planned_failover.md b/doc/administration/geo/disaster_recovery/planned_failover.md index 479ece41b8c3..db2b15a66f4a 100644 --- a/doc/administration/geo/disaster_recovery/planned_failover.md +++ b/doc/administration/geo/disaster_recovery/planned_failover.md @@ -199,7 +199,7 @@ If a runner is repeatedly unable to connect to a GitLab instance, it stops tryin To ensure that all data is replicated to a secondary site, updates (write requests) need to be disabled on the **primary** site: -1. Enable [maintenance mode](../../maintenance_mode/index.md) on the **primary** site. +1. Enable [maintenance mode](../../maintenance_mode/_index.md) on the **primary** site. 1. On the left sidebar, at the bottom, select **Admin**. 1. Select **Monitoring > Background jobs**. 1. On the Sidekiq dashboard, select **Cron**. diff --git a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md index 06f2728a5027..5f0e70931ca8 100644 --- a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md +++ b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md @@ -95,8 +95,8 @@ ensure these processes are close to 100% as possible during active use. If the **secondary** site is still replicating data from the **primary** site, follow these steps to avoid unnecessary data loss: -1. Enable [maintenance mode](../../../maintenance_mode/index.md) on the **primary** site, - and make sure to stop any [background jobs](../../../maintenance_mode/index.md#background-jobs). +1. Enable [maintenance mode](../../../maintenance_mode/_index.md) on the **primary** site, + and make sure to stop any [background jobs](../../../maintenance_mode/_index.md#background-jobs). 1. Finish replicating and verifying all data: WARNING: diff --git a/doc/administration/geo/replication/configuration.md b/doc/administration/geo/replication/configuration.md index e4afadab61b4..98275f8213e8 100644 --- a/doc/administration/geo/replication/configuration.md +++ b/doc/administration/geo/replication/configuration.md @@ -248,7 +248,7 @@ In the following steps, replace `<ssh_host_key_path>` with the one you're using: gitlab-rake gitlab:geo:check ``` - If any of the checks fail, check the [troubleshooting documentation](troubleshooting/index.md). + If any of the checks fail, check the [troubleshooting documentation](troubleshooting/_index.md). 1. SSH into a **Rails or Sidekiq server on your primary** site and login as root to verify the **secondary** site is reachable or there are any common issues with your Geo setup: @@ -257,7 +257,7 @@ In the following steps, replace `<ssh_host_key_path>` with the one you're using: gitlab-rake gitlab:geo:check ``` - If any of the checks fail, check the [troubleshooting documentation](troubleshooting/index.md). + If any of the checks fail, check the [troubleshooting documentation](troubleshooting/_index.md). After the **secondary** site is added to the Geo administration page and restarted, the site automatically starts replicating missing data from the **primary** site @@ -357,14 +357,14 @@ site's **Geo Sites** dashboard in your browser.  If your installation isn't working properly, check the -[troubleshooting document](troubleshooting/index.md). +[troubleshooting document](troubleshooting/_index.md). The two most obvious issues that can become apparent in the dashboard are: 1. Database replication not working well. 1. Instance to instance notification not working. In that case, it can be something of the following: - - You are using a custom certificate or custom CA (see the [troubleshooting document](troubleshooting/index.md)). + - You are using a custom certificate or custom CA (see the [troubleshooting document](troubleshooting/_index.md)). - The instance is firewalled (check your firewall rules). Disabling a **secondary** site stops the synchronization process. @@ -384,4 +384,4 @@ Currently, this is what is synced: ## Troubleshooting -See the [troubleshooting document](troubleshooting/index.md). +See the [troubleshooting document](troubleshooting/_index.md). diff --git a/doc/administration/geo/replication/datatypes.md b/doc/administration/geo/replication/datatypes.md index ddc00029985e..9f1745aace49 100644 --- a/doc/administration/geo/replication/datatypes.md +++ b/doc/administration/geo/replication/datatypes.md @@ -202,8 +202,8 @@ successfully, you must replicate their data using some other means. | [Versioned Terraform State](../../terraform_state.md) | **Yes** (13.5) | **Yes** (13.12) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | Replication is behind the feature flag `geo_terraform_state_version_replication`, enabled by default. Verification was behind the feature flag `geo_terraform_state_version_verification`, which was removed in 14.0. | | [External merge request diffs](../../merge_request_diffs.md) | **Yes** (13.5) | **Yes** (14.6) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | Replication is behind the feature flag `geo_merge_request_diff_replication`, enabled by default. Verification was behind the feature flag `geo_merge_request_diff_verification`, removed in 14.7. | | [Versioned snippets](../../../user/snippets.md#versioned-snippets) | [**Yes** (13.7)](https://gitlab.com/groups/gitlab-org/-/epics/2809) | [**Yes** (14.2)](https://gitlab.com/groups/gitlab-org/-/epics/2810) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | Verification was implemented behind the feature flag `geo_snippet_repository_verification` in 13.11, and the feature flag was removed in 14.2. | -| [GitLab Pages](../../pages/index.md) | [**Yes** (14.3)](https://gitlab.com/groups/gitlab-org/-/epics/589) | **Yes** (14.6) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | Behind feature flag `geo_pages_deployment_replication`, enabled by default. Verification was behind the feature flag `geo_pages_deployment_verification`, removed in 14.7. | -| [Project-level Secure files](../../../ci/secure_files/_index.md) | **Yes** (15.3) | **Yes** (15.3) | **Yes** (15.3) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | | +| [GitLab Pages](../../pages/_index.md) | [**Yes** (14.3)](https://gitlab.com/groups/gitlab-org/-/epics/589) | **Yes** (14.6) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | Behind feature flag `geo_pages_deployment_replication`, enabled by default. Verification was behind the feature flag `geo_pages_deployment_verification`, removed in 14.7. | +| [Project-level Secure files](../../../ci/secure_files/_index.md) | **Yes** (15.3) | **Yes** (15.3) | **Yes** (15.3) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | | | [Incident Metric Images](../../../operations/incident_management/incidents.md#metrics) | **Yes** (15.5) | **Yes** (15.5) | **Yes** (15.5) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | Replication/Verification is handled via the Uploads data type. | | [Alert Metric Images](../../../operations/incident_management/alerts.md#metrics-tab) | **Yes** (15.5) | **Yes** (15.5) | **Yes** (15.5) | [**Yes** (16.4)<sup>3</sup>](https://gitlab.com/groups/gitlab-org/-/epics/8056) | Replication/Verification is handled via the Uploads data type. | | [Server-side Git hooks](../../server_hooks.md) | [Not planned](https://gitlab.com/groups/gitlab-org/-/epics/1867) | No | Not applicable | Not applicable | Not planned because of current implementation complexity, low customer interest, and availability of alternatives to hooks. | diff --git a/doc/administration/geo/replication/faq.md b/doc/administration/geo/replication/faq.md index 04c931b10520..6f7c3fc72815 100644 --- a/doc/administration/geo/replication/faq.md +++ b/doc/administration/geo/replication/faq.md @@ -11,7 +11,7 @@ DETAILS: ## What are the minimum requirements to run Geo? -The requirements are listed [on the index page](../index.md#requirements-for-running-geo) +The requirements are listed [on the index page](../_index.md#requirements-for-running-geo) ## How does Geo know which projects to sync? diff --git a/doc/administration/geo/replication/multiple_servers.md b/doc/administration/geo/replication/multiple_servers.md index 53b61a264f67..9cc94385e031 100644 --- a/doc/administration/geo/replication/multiple_servers.md +++ b/doc/administration/geo/replication/multiple_servers.md @@ -110,7 +110,7 @@ major differences: - There is an additional PostgreSQL database for each Geo **secondary** site, called the "Geo tracking database", which tracks the replication and verification state of various resources. -- There is an additional GitLab service [`geo-logcursor`](../index.md#geo-log-cursor) +- There is an additional GitLab service [`geo-logcursor`](../_index.md#geo-log-cursor) Therefore, we set up the multi-node components one by one and include deviations from the typical multi-node setup. However, we highly recommend configuring a diff --git a/doc/administration/geo/replication/security_review.md b/doc/administration/geo/replication/security_review.md index 3393f50687a8..a1cc0c5d8adc 100644 --- a/doc/administration/geo/replication/security_review.md +++ b/doc/administration/geo/replication/security_review.md @@ -125,7 +125,7 @@ from [owasp.org](https://owasp.org/). - Geo imposes no additional restrictions on operating system (see the [GitLab installation](https://about.gitlab.com/install/) page for more - details), however we recommend using the operating systems listed in the [Geo documentation](../index.md#requirements-for-running-geo). + details), however we recommend using the operating systems listed in the [Geo documentation](../_index.md#requirements-for-running-geo). ### What details regarding required OS components and lockâ€down needs have been defined? diff --git a/doc/administration/geo/replication/selective_synchronization.md b/doc/administration/geo/replication/selective_synchronization.md index 8cf2358b5fa2..dbcedabc352d 100644 --- a/doc/administration/geo/replication/selective_synchronization.md +++ b/doc/administration/geo/replication/selective_synchronization.md @@ -17,7 +17,7 @@ latter is more suited to progressively rolling out Geo to a large GitLab instance. NOTE: -Geo's synchronization logic is outlined in the [documentation](../index.md). Both the solution and the documentation is subject to change from time to time. You must independently determine your legal obligations in regard to privacy and cybersecurity laws, and applicable trade control law on an ongoing basis. +Geo's synchronization logic is outlined in the [documentation](../_index.md). Both the solution and the documentation is subject to change from time to time. You must independently determine your legal obligations in regard to privacy and cybersecurity laws, and applicable trade control law on an ongoing basis. Selective synchronization: diff --git a/doc/administration/geo/replication/troubleshooting/index.md b/doc/administration/geo/replication/troubleshooting/_index.md similarity index 100% rename from doc/administration/geo/replication/troubleshooting/index.md rename to doc/administration/geo/replication/troubleshooting/_index.md diff --git a/doc/administration/geo/replication/troubleshooting/client_http.md b/doc/administration/geo/replication/troubleshooting/client_http.md index e06e5874bd29..e7fa9b3f3920 100644 --- a/doc/administration/geo/replication/troubleshooting/client_http.md +++ b/doc/administration/geo/replication/troubleshooting/client_http.md @@ -93,7 +93,7 @@ Geo::TrackingBase::SecondaryNotConfigured: Geo secondary database is not configu On a Geo primary site this error can be ignored. -This happens because GitLab is attempting to display registries from the [Geo tracking database](../../../geo/index.md#geo-tracking-database) which doesn't exist on the primary site (only the original projects exist on the primary; no replicated projects are present, therefore no tracking database exists). +This happens because GitLab is attempting to display registries from the [Geo tracking database](../../../geo/_index.md#geo-tracking-database) which doesn't exist on the primary site (only the original projects exist on the primary; no replicated projects are present, therefore no tracking database exists). ### Secondary site returns 400 error "Request header or cookie too large" diff --git a/doc/administration/geo/replication/troubleshooting/common.md b/doc/administration/geo/replication/troubleshooting/common.md index 079a63cacf15..d7dab5642034 100644 --- a/doc/administration/geo/replication/troubleshooting/common.md +++ b/doc/administration/geo/replication/troubleshooting/common.md @@ -463,7 +463,7 @@ This machine's Geo node name matches a database record ... no You could add or update a Geo node database record, setting the name to "https://example.com/". Or you could set this machine's Geo node name to match the name of an existing database record: "London", "Shanghai" For more information see: - doc/administration/geo/replication/troubleshooting/index.md#can-geo-detect-the-current-node-correctly + doc/administration/geo/replication/troubleshooting/_index.md#can-geo-detect-the-current-node-correctly ``` For more information about recommended site names in the description of the Name field, see @@ -471,7 +471,7 @@ For more information about recommended site names in the description of the Name ### Check OS locale data compatibility -If at all possible, all Geo nodes across all sites should be deployed with the same method and operating system, as defined in the [requirements for running Geo](../../index.md#requirements-for-running-geo). +If at all possible, all Geo nodes across all sites should be deployed with the same method and operating system, as defined in the [requirements for running Geo](../../_index.md#requirements-for-running-geo). If different operating systems or different operating system versions are deployed across Geo sites, you **must** perform a locale data compatibility check before setting up Geo. You must also check `glibc` when using a mixture of GitLab deployment methods. The locale might be different between a Linux package install, a GitLab Docker container, a Helm chart deployment, or external database services. See the [documentation on upgrading operating systems for PostgreSQL](../../../postgresql/upgrading_os.md), including how to check `glibc` version compatibility. @@ -561,7 +561,7 @@ If you set up a new secondary from scratch, you must also [remove the old site f The most common problems that prevent the database from replicating correctly are: - **Secondary** sites cannot reach the **primary** site. Check credentials and - [firewall rules](../../index.md#firewall-rules). + [firewall rules](../../_index.md#firewall-rules). - SSL certificate problems. Make sure you copied `/etc/gitlab/gitlab-secrets.json` from the **primary** site. - Database storage disk is full. - Database replication slot is misconfigured. diff --git a/doc/administration/geo/replication/troubleshooting/synchronization_verification.md b/doc/administration/geo/replication/troubleshooting/synchronization_verification.md index 13480c933294..8c1dd5851938 100644 --- a/doc/administration/geo/replication/troubleshooting/synchronization_verification.md +++ b/doc/administration/geo/replication/troubleshooting/synchronization_verification.md @@ -622,7 +622,7 @@ To solve this: ## Failures during backfill -During a [backfill](../../index.md#backfill), failures are scheduled to be retried at the end +During a [backfill](../../_index.md#backfill), failures are scheduled to be retried at the end of the backfill queue, therefore these failures only clear up **after** the backfill completes. ## Message: `unexpected disconnect while reading sideband packet` diff --git a/doc/administration/geo/replication/upgrading_the_geo_sites.md b/doc/administration/geo/replication/upgrading_the_geo_sites.md index 97e0977feafb..fce686ada031 100644 --- a/doc/administration/geo/replication/upgrading_the_geo_sites.md +++ b/doc/administration/geo/replication/upgrading_the_geo_sites.md @@ -43,7 +43,7 @@ and all **secondary** sites: 1. Ensure that the secrets in the `/etc/gitlab/gitlab-secrets.json` file of both the primary site and the secondary site are the same. The file must be the same on all of a site's nodes. 1. SSH into each node of **secondary** sites. 1. [Upgrade GitLab on each **secondary** site](../../../update/package/_index.md#by-using-the-official-repositories-recommended). -1. If you paused replication in step 1, [resume replication on each **secondary**](../index.md#pausing-and-resuming-replication). +1. If you paused replication in step 1, [resume replication on each **secondary**](../_index.md#pausing-and-resuming-replication). Then, restart Puma and Sidekiq on each **secondary** site. This is to ensure they are initialized against the newer database schema that is now replicated from the previously upgraded **primary** site. @@ -70,4 +70,4 @@ everything is working correctly: 1. Test the data replication by pushing code to the **primary** site and see if it is received by **secondary** sites. -If you encounter any issues, see the [Geo troubleshooting guide](troubleshooting/index.md). +If you encounter any issues, see the [Geo troubleshooting guide](troubleshooting/_index.md). diff --git a/doc/administration/geo/secondary_proxy/_index.md b/doc/administration/geo/secondary_proxy/_index.md index 5ee24c074634..43eb5d0533eb 100644 --- a/doc/administration/geo/secondary_proxy/_index.md +++ b/doc/administration/geo/secondary_proxy/_index.md @@ -29,7 +29,7 @@ This behavior enables use-cases including: For an overview, see [Geo proxying for secondary sites](https://www.youtube.com/watch?v=TALLy7__Na8). <!-- Video published on 2022-01-26 --> -For known issues, see [proxying-related items in the Geo documentation](../index.md#known-issues). +For known issues, see [proxying-related items in the Geo documentation](../_index.md#known-issues). ## Set up a unified URL for Geo sites diff --git a/doc/administration/geo/setup/_index.md b/doc/administration/geo/setup/_index.md index 31f80536e78c..84dd9319ccf2 100644 --- a/doc/administration/geo/setup/_index.md +++ b/doc/administration/geo/setup/_index.md @@ -19,7 +19,7 @@ DETAILS: Geo supports multiple secondaries. You can follow the same steps and make any changes accordingly. - Ensure the **primary** site has a [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) subscription to unlock Geo. You only need one license for all the sites. -- Confirm the [requirements for running Geo](../index.md#requirements-for-running-geo) are met by all sites. For example, sites must use the same GitLab version, and sites must be able to communicate with each other over certain ports. +- Confirm the [requirements for running Geo](../_index.md#requirements-for-running-geo) are met by all sites. For example, sites must use the same GitLab version, and sites must be able to communicate with each other over certain ports. - Confirm the **primary** and **secondary** site storage configurations match. If the primary Geo site uses object storage, the secondary Geo site must use it too. For more information, see [Geo with Object storage](../replication/object_storage.md). - Ensure clocks are synchronized between the **primary** site and the **secondary** site. Synchronized clocks are required for Geo to function correctly. For example, if the clock drift between the **primary** and **secondary** sites exceeds 1 minute, replication fails. @@ -59,7 +59,7 @@ Depending on your GitLab deployment, [additional configuration](#additional-conf Depending on how you use GitLab, the following configuration might be required: - If the **primary** site uses object storage, [configure object storage replication](../replication/object_storage.md) for the **secondary** sites. -- If you use LDAP, [configure a secondary LDAP server](../../auth/ldap/index.md) for the **secondary** sites. +- If you use LDAP, [configure a secondary LDAP server](../../auth/ldap/_index.md) for the **secondary** sites. For more information, see [LDAP with Geo](../replication/single_sign_on.md#ldap). - If you use the container registry, [configure the container registry for replication](../replication/container_registry.md) on the **primary** and **secondary** sites. @@ -75,4 +75,4 @@ Geo is not supported when you use a [self-compiled GitLab installation](../../.. ## Post-installation documentation -After installing GitLab on the **secondary** sites and performing the initial configuration, see the [following documentation for post-installation information](../index.md#post-installation-documentation). +After installing GitLab on the **secondary** sites and performing the initial configuration, see the [following documentation for post-installation information](../_index.md#post-installation-documentation). diff --git a/doc/administration/geo/setup/database.md b/doc/administration/geo/setup/database.md index 45994e6fef48..91002373a6d7 100644 --- a/doc/administration/geo/setup/database.md +++ b/doc/administration/geo/setup/database.md @@ -57,7 +57,7 @@ The following guide assumes that: - You have a **primary** site already set up (the GitLab server you are replicating from), running PostgreSQL (or equivalent version) managed by your Linux package installation, and you have a new **secondary** site set up with the same - [versions of PostgreSQL](../index.md#requirements-for-running-geo), + [versions of PostgreSQL](../_index.md#requirements-for-running-geo), OS, and GitLab on all sites. WARNING: @@ -1065,4 +1065,4 @@ Follow [Geo with external PostgreSQL instances](external_database.md#configure-t ## Troubleshooting -Read the [troubleshooting document](../replication/troubleshooting/index.md). +Read the [troubleshooting document](../replication/troubleshooting/_index.md). diff --git a/doc/administration/geo/setup/external_database.md b/doc/administration/geo/setup/external_database.md index a0e127aad592..e6d382277b15 100644 --- a/doc/administration/geo/setup/external_database.md +++ b/doc/administration/geo/setup/external_database.md @@ -16,7 +16,7 @@ or manually installed and configured PostgreSQL instances. Ensure that you are using one of the PostgreSQL versions that the [Linux package ships with](../../package_information/postgresql_versions.md) -to [avoid version mismatches](../index.md#requirements-for-running-geo) +to [avoid version mismatches](../_index.md#requirements-for-running-geo) in case a Geo site has to be rebuilt. NOTE: @@ -158,7 +158,7 @@ has three main functions: 1. Configure the replica database. 1. Configure the tracking database. -1. Enable the [Geo Log Cursor](../index.md#geo-log-cursor) (not covered in this section). +1. Enable the [Geo Log Cursor](../_index.md#geo-log-cursor) (not covered in this section). To configure the connection to the external read-replica database and enable Log Cursor: diff --git a/doc/administration/geo/setup/two_single_node_external_services.md b/doc/administration/geo/setup/two_single_node_external_services.md index 3ef68a90888b..e152e68c0989 100644 --- a/doc/administration/geo/setup/two_single_node_external_services.md +++ b/doc/administration/geo/setup/two_single_node_external_services.md @@ -19,7 +19,7 @@ Prerequisites: - The second GitLab site serves as the **Geo secondary site**. Geo supports multiple secondary sites. - The Geo primary site has at least a [GitLab Premium](https://about.gitlab.com/pricing/) license. You need only one license for all sites. -- Confirm all sites meet the [requirements for running Geo](../index.md#requirements-for-running-geo). +- Confirm all sites meet the [requirements for running Geo](../_index.md#requirements-for-running-geo). ## Set up Geo for Linux package (Omnibus) @@ -90,7 +90,7 @@ has three main functions: 1. Configure the replica database. 1. Configure the tracking database. -1. Enable the [Geo Log Cursor](../index.md#geo-log-cursor). +1. Enable the [Geo Log Cursor](../_index.md#geo-log-cursor). To configure the connection to the external read-replica database: @@ -339,7 +339,7 @@ secondary site is a read-only copy. sudo gitlab-rake gitlab:geo:check ``` - If any of the checks fail, see the [troubleshooting documentation](../replication/troubleshooting/index.md). + If any of the checks fail, see the [troubleshooting documentation](../replication/troubleshooting/_index.md). 1. To verify that the secondary site is reachable, SSH into a Rails or Sidekiq server on your primary site and run: @@ -347,7 +347,7 @@ secondary site is a read-only copy. sudo gitlab-rake gitlab:geo:check ``` - If any of the checks fail, check the [troubleshooting documentation](../replication/troubleshooting/index.md). + If any of the checks fail, check the [troubleshooting documentation](../replication/troubleshooting/_index.md). After the secondary site is added to the Geo administration page and restarted, the site automatically starts to replicate missing data from the primary site @@ -493,4 +493,4 @@ The reconfigure in the [steps above](#configure-gitlab) handles these steps auto ## Troubleshooting -See [troubleshooting Geo](../replication/troubleshooting/index.md). +See [troubleshooting Geo](../replication/troubleshooting/_index.md). diff --git a/doc/administration/geo/setup/two_single_node_sites.md b/doc/administration/geo/setup/two_single_node_sites.md index 28274ae23559..eb5ee75c8a79 100644 --- a/doc/administration/geo/setup/two_single_node_sites.md +++ b/doc/administration/geo/setup/two_single_node_sites.md @@ -19,7 +19,7 @@ Prerequisites: - The second GitLab site serves as the **Geo secondary site**. Geo supports multiple secondary sites. - The Geo primary site has at least a [GitLab Premium](https://about.gitlab.com/pricing/) license. You need only one license for all sites. -- Confirm all sites meet the [requirements for running Geo](../index.md#requirements-for-running-geo). +- Confirm all sites meet the [requirements for running Geo](../_index.md#requirements-for-running-geo). ## Set up Geo for Linux package (Omnibus) @@ -593,7 +593,7 @@ You must manually replicate the secret file across all of your secondary sites, gitlab-rake gitlab:geo:check ``` - If any of the checks fail, see the [troubleshooting documentation](../replication/troubleshooting/index.md). + If any of the checks fail, see the [troubleshooting documentation](../replication/troubleshooting/_index.md). 1. To verify that the secondary site is reachable, SSH into a Rails or Sidekiq server on your primary site and sign in as root: @@ -601,7 +601,7 @@ You must manually replicate the secret file across all of your secondary sites, gitlab-rake gitlab:geo:check ``` - If any of the checks fail, check the [troubleshooting documentation](../replication/troubleshooting/index.md). + If any of the checks fail, check the [troubleshooting documentation](../replication/troubleshooting/_index.md). After the secondary site is added to the Geo administration page and restarted, the site automatically starts to replicate missing data from the primary site @@ -649,4 +649,4 @@ site **Geo Sites** dashboard in your browser. ## Related topics -- [Troubleshooting Geo](../replication/troubleshooting/index.md) +- [Troubleshooting Geo](../replication/troubleshooting/_index.md) diff --git a/doc/administration/geo_sites.md b/doc/administration/geo_sites.md index ca70e4a1162f..14fdf4c081e5 100644 --- a/doc/administration/geo_sites.md +++ b/doc/administration/geo_sites.md @@ -10,7 +10,7 @@ DETAILS: **Offering:** GitLab Self-Managed You can configure various settings for GitLab Geo sites. For more information, see -[Geo documentation](geo/index.md). +[Geo documentation](geo/_index.md). On either the primary or secondary site: diff --git a/doc/administration/gitaly/_index.md b/doc/administration/gitaly/_index.md index 2e8c126f3b74..4cb28f3dee81 100644 --- a/doc/administration/gitaly/_index.md +++ b/doc/administration/gitaly/_index.md @@ -272,13 +272,13 @@ RPO and RTO discussed above. ### Comparison to Geo -Gitaly Cluster and [Geo](../geo/index.md) both provide redundancy. However the redundancy of: +Gitaly Cluster and [Geo](../geo/_index.md) both provide redundancy. However the redundancy of: - Gitaly Cluster provides fault tolerance for data storage and is invisible to the user. Users are not aware when Gitaly Cluster is used. -- Geo provides [replication](../geo/index.md) and [disaster recovery](../geo/disaster_recovery/_index.md) for +- Geo provides [replication](../geo/_index.md) and [disaster recovery](../geo/disaster_recovery/_index.md) for an entire instance of GitLab. Users know when they are using Geo for - [replication](../geo/index.md). Geo [replicates multiple data types](../geo/replication/datatypes.md#replicated-data-types), + [replication](../geo/_index.md). Geo [replicates multiple data types](../geo/replication/datatypes.md#replicated-data-types), including Git data. The following table outlines the major differences between Gitaly Cluster and Geo: @@ -290,8 +290,8 @@ The following table outlines the major differences between Gitaly Cluster and Ge For more information, see: -- Geo [use cases](../geo/index.md#use-cases). -- Geo [architecture](../geo/index.md#architecture). +- Geo [use cases](../geo/_index.md#use-cases). +- Geo [architecture](../geo/_index.md#architecture). ### Virtual storage diff --git a/doc/administration/gitaly/gitaly_geo_capabilities.md b/doc/administration/gitaly/gitaly_geo_capabilities.md index 37c33f5ceed2..8eb84fe6df11 100644 --- a/doc/administration/gitaly/gitaly_geo_capabilities.md +++ b/doc/administration/gitaly/gitaly_geo_capabilities.md @@ -19,7 +19,7 @@ The following tables are intended to guide you to choose the right combination o ## Geo capabilities -If your availability needs to span multiple zones or multiple locations, read about [Geo](../geo/index.md). +If your availability needs to span multiple zones or multiple locations, read about [Geo](../geo/_index.md). | Capability | Availability | Recoverability | Data Resiliency | Performance | Risks/Trade-offs| |------------|--------------|----------------|-----------------|-------------|-----------------| diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 7521dcc83ad5..03238d897f58 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -180,7 +180,7 @@ following to `gitlab.rb` on each node: NOTE: Do not store the GitLab application database and the Praefect -database on the same PostgreSQL server if using [Geo](../geo/index.md). +database on the same PostgreSQL server if using [Geo](../geo/_index.md). The replication state is internal to each instance of GitLab and should not be replicated. diff --git a/doc/administration/instance_limits.md b/doc/administration/instance_limits.md index 3cb04b863a7a..8338c9fbeb49 100644 --- a/doc/administration/instance_limits.md +++ b/doc/administration/instance_limits.md @@ -689,7 +689,7 @@ The total number of custom domains per GitLab Pages website is limited to `150` The default limit for [GitLab Self-Managed](../subscriptions/self_managed/_index.md) is `0` (unlimited). To set a limit on your instance, use the -[**Admin** area](pages/index.md#set-maximum-number-of-gitlab-pages-custom-domains-for-a-project). +[**Admin** area](pages/_index.md#set-maximum-number-of-gitlab-pages-custom-domains-for-a-project). ### Number of parallel Pages deployments @@ -1022,7 +1022,7 @@ that only people you trust can add content. ## Wiki limits -- [Wiki page content size limit](wikis/index.md#wiki-page-content-size-limit). +- [Wiki page content size limit](wikis/_index.md#wiki-page-content-size-limit). - [Length restrictions for file and directory names](../user/project/wiki/index.md#length-restrictions-for-file-and-directory-names). ## Snippets limits diff --git a/doc/administration/license.md b/doc/administration/license.md index c95b1357151c..acf5e198d556 100644 --- a/doc/administration/license.md +++ b/doc/administration/license.md @@ -106,7 +106,7 @@ To find more details about the error, you can use your browser's developer tools To resolve the issue: -- If the GraphQL response includes `only get, head, options, and trace methods are allowed in silent mode`, disable [silent mode](silent_mode/index.md#disable-silent-mode) for your instance. +- If the GraphQL response includes `only get, head, options, and trace methods are allowed in silent mode`, disable [silent mode](silent_mode/_index.md#disable-silent-mode) for your instance. If you are unable to determine the issue, contact [GitLab Support](https://about.gitlab.com/support/portal/) and provide the GraphQL response in your description of the issue. diff --git a/doc/administration/load_balancer.md b/doc/administration/load_balancer.md index 375710a73f68..ae3fcb7ae014 100644 --- a/doc/administration/load_balancer.md +++ b/doc/administration/load_balancer.md @@ -87,7 +87,7 @@ If you're using GitLab Pages with custom domain support you need some additional port configurations. GitLab Pages requires a separate virtual IP address. Configure DNS to point the `pages_external_url` from `/etc/gitlab/gitlab.rb` at the new virtual IP address. See the -[GitLab Pages documentation](pages/index.md) for more information. +[GitLab Pages documentation](pages/_index.md) for more information. | LB Port | Backend Port | Protocol | | ------- | ------------- | --------- | @@ -96,7 +96,7 @@ GitLab Pages requires a separate virtual IP address. Configure DNS to point the - (*1*): The backend port for GitLab Pages depends on the `gitlab_pages['external_http']` and `gitlab_pages['external_https']` - setting. See [GitLab Pages documentation](pages/index.md) for more details. + setting. See [GitLab Pages documentation](pages/_index.md) for more details. - (*2*): Port 443 for GitLab Pages should always use the TCP protocol. Users can configure custom domains with custom SSL, which would not be possible if SSL was terminated at the load balancer. diff --git a/doc/administration/logs/log_parsing.md b/doc/administration/logs/log_parsing.md index f6dc05a441bc..93f0c1174631 100644 --- a/doc/administration/logs/log_parsing.md +++ b/doc/administration/logs/log_parsing.md @@ -234,7 +234,7 @@ the following command helps to focus on the most common errors. jq --raw-output 'select(.severity == "ERROR") | [.project_path, .class, .message, .error] | @tsv' geo.log | sort | uniq -c | sort | tail ``` -Refer to our [Geo troubleshooting page](../geo/replication/troubleshooting/index.md) +Refer to our [Geo troubleshooting page](../geo/replication/troubleshooting/_index.md) for advice about specific error messages. ### Parsing `gitaly/current` diff --git a/doc/administration/maintenance_mode/index.md b/doc/administration/maintenance_mode/_index.md similarity index 97% rename from doc/administration/maintenance_mode/index.md rename to doc/administration/maintenance_mode/_index.md index 6a69714390b5..5580d0f2a4fc 100644 --- a/doc/administration/maintenance_mode/index.md +++ b/doc/administration/maintenance_mode/_index.md @@ -72,7 +72,7 @@ them to disable Maintenance Mode after it's been enabled. All users can sign in and out of the GitLab instance but no new users can be created. -If there are [LDAP syncs](../auth/ldap/index.md) scheduled for that time, they fail because user creation is disabled. Similarly, [user creations based on SAML](../../integration/saml.md#configure-saml-support-in-gitlab) fail. +If there are [LDAP syncs](../auth/ldap/_index.md) scheduled for that time, they fail because user creation is disabled. Similarly, [user creations based on SAML](../../integration/saml.md#configure-saml-support-in-gitlab) fail. ### Git actions diff --git a/doc/administration/moderate_users.md b/doc/administration/moderate_users.md index 3f09fe36d9bd..9ed351141408 100644 --- a/doc/administration/moderate_users.md +++ b/doc/administration/moderate_users.md @@ -22,7 +22,7 @@ pending approval state because an administrator has enabled any of the following - [Require administrator approval for new sign-ups](settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups) setting. - [User cap](settings/sign_up_restrictions.md#user-cap). - [Block auto-created users (OmniAuth)](../integration/omniauth.md#configure-common-settings) -- [Block auto-created users (LDAP)](auth/ldap/index.md#basic-configuration-settings) +- [Block auto-created users (LDAP)](auth/ldap/_index.md#basic-configuration-settings) When a user registers for an account while this setting is enabled: diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 0cfe8e325447..827b1e3291eb 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -114,10 +114,10 @@ The following table lists the valid `objects` that can be used: | `external_diffs` | [Merge request diffs](merge_request_diffs.md) | | `uploads` | [User uploads](uploads.md) | | `lfs` | [Git Large File Storage objects](lfs/_index.md) | -| `packages` | [Project packages (for example, PyPI, Maven, or NuGet)](packages/index.md) | +| `packages` | [Project packages (for example, PyPI, Maven, or NuGet)](packages/_index.md) | | `dependency_proxy` | [Dependency Proxy](packages/dependency_proxy.md) | | `terraform_state` | [Terraform state files](terraform_state.md) | -| `pages` | [Pages](pages/index.md) | +| `pages` | [Pages](pages/_index.md) | | `ci_secure_files` | [Secure files](cicd/secure_files.md) | Within each object type, three parameters can be defined: @@ -175,10 +175,10 @@ supported by the consolidated form, refer to the following guides: | [LFS objects](lfs/_index.md#storing-lfs-objects-in-remote-object-storage) | **{check-circle}** Yes | | [Uploads](uploads.md#using-object-storage) | **{check-circle}** Yes | | [Merge request diffs](merge_request_diffs.md#using-object-storage) | **{check-circle}** Yes | -| [Packages](packages/index.md#use-object-storage) (optional feature) | **{check-circle}** Yes | +| [Packages](packages/_index.md#use-object-storage) (optional feature) | **{check-circle}** Yes | | [Dependency Proxy](packages/dependency_proxy.md#using-object-storage) (optional feature) | **{check-circle}** Yes | | [Terraform state files](terraform_state.md#using-object-storage) | **{check-circle}** Yes | -| [Pages content](pages/index.md#object-storage-settings) | **{check-circle}** Yes | +| [Pages content](pages/_index.md#object-storage-settings) | **{check-circle}** Yes | ## Configure the connection settings @@ -748,10 +748,10 @@ To migrate existing local data to object storage see the following guides: - [LFS objects](lfs/_index.md#migrating-to-object-storage) - [Uploads](raketasks/uploads/migrate.md#migrate-to-object-storage) - [Merge request diffs](merge_request_diffs.md#using-object-storage) -- [Packages](packages/index.md#migrate-local-packages-to-object-storage) (optional feature) +- [Packages](packages/_index.md#migrate-local-packages-to-object-storage) (optional feature) - [Dependency Proxy](packages/dependency_proxy.md#migrate-local-dependency-proxy-blobs-and-manifests-to-object-storage) - [Terraform state files](terraform_state.md#migrate-to-object-storage) -- [Pages content](pages/index.md#migrate-pages-deployments-to-object-storage) +- [Pages content](pages/_index.md#migrate-pages-deployments-to-object-storage) - [Project-level Secure Files](cicd/secure_files.md#migrate-to-object-storage) ## Transition to consolidated form @@ -843,7 +843,7 @@ See the following additional guides: 1. Configure [database lookup of SSH keys](operations/fast_ssh_key_lookup.md) to eliminate the need for a shared `authorized_keys` file. 1. [Prevent local disk usage for job logs](cicd/job_logs.md#prevent-local-disk-usage). -1. [Disable Pages local storage](pages/index.md#disable-pages-local-storage). +1. [Disable Pages local storage](pages/_index.md#disable-pages-local-storage). ## Troubleshooting @@ -899,7 +899,7 @@ This is not the default behavior with object storage. The `proxy_download` setting controls this behavior: the default is `false`. Verify this in the documentation for each use case. -Set `proxy_download` to `true` if you want GitLab to proxy the files. +Set `proxy_download` to `true` if you want GitLab to proxy the files. There can be a large performance hit to the GitLab server if `proxy_download` is set to `true`. The server deployments of GitLab have `proxy_download` set to `false`. When `proxy_download` to `false`, GitLab returns an diff --git a/doc/administration/operations/fast_ssh_key_lookup.md b/doc/administration/operations/fast_ssh_key_lookup.md index fa0dbb9abea3..de79f8a1b081 100644 --- a/doc/administration/operations/fast_ssh_key_lookup.md +++ b/doc/administration/operations/fast_ssh_key_lookup.md @@ -41,7 +41,7 @@ getent passwd git | cut -d: -f6 | awk '{print $1"/.ssh/authorized_keys"}' ``` The `authorized_keys` file contains all the public SSH keys for users allowed to access GitLab. However, to maintain a -single source of truth, [Geo](../geo/index.md) must be configured to perform SSH fingerprint +single source of truth, [Geo](../geo/_index.md) must be configured to perform SSH fingerprint lookups with database lookup. When you [set up Geo](../geo/setup/_index.md), you must follow the steps below diff --git a/doc/administration/operations/moving_repositories.md b/doc/administration/operations/moving_repositories.md index 9deea8fd6e10..e149eed01f20 100644 --- a/doc/administration/operations/moving_repositories.md +++ b/doc/administration/operations/moving_repositories.md @@ -54,7 +54,7 @@ To move repositories: [individual snippets](../../api/snippet_repository_storage_moves.md#schedule-a-repository-storage-move-for-a-snippet). - [All groups](#move-all-groups) or [individual groups](../../api/group_repository_storage_moves.md#schedule-a-repository-storage-move-for-a-group). -1. If [Geo](../geo/index.md) is enabled, +1. If [Geo](../geo/_index.md) is enabled, [resync all repositories](../geo/replication/troubleshooting/synchronization_verification.md#queue-up-all-repositories-for-resync). #### Move all projects diff --git a/doc/administration/package_information/postgresql_versions.md b/doc/administration/package_information/postgresql_versions.md index ffefe9ba528e..08cc9ae5a9ca 100644 --- a/doc/administration/package_information/postgresql_versions.md +++ b/doc/administration/package_information/postgresql_versions.md @@ -35,7 +35,7 @@ Read more about update policies and warnings in the PostgreSQL | First GitLab version | PostgreSQL versions | Default version for fresh installs | Default version for upgrades | Notes | | -------------- | ------------------- | ---------------------------------- | ---------------------------- | ----- | | 17.5.0 | 14.11, 16.4 | 14.11 | 16.4 | Single node upgrades from PostgreSQL 14 to PostgreSQL 16 are now supported. Starting with GitLab 17.5.0, PostgreSQL 16 is fully supported for both new installations and upgrades in Geo deployments (the restriction from 17.4.0 no longer applies). | -| 17.4.0 | 14.11, 16.4 | 14.11 | 14.11 | PostgreSQL 16 is available for new installations if not using [Geo](../geo/index.md#requirements-for-running-geo) or [Patroni](../postgresql/_index.md#postgresql-replication-and-failover-for-linux-package-installations). | +| 17.4.0 | 14.11, 16.4 | 14.11 | 14.11 | PostgreSQL 16 is available for new installations if not using [Geo](../geo/_index.md#requirements-for-running-geo) or [Patroni](../postgresql/_index.md#postgresql-replication-and-failover-for-linux-package-installations). | | 17.0.0 | 14.11 | 14.11 | 14.11 | Package upgrades are aborted if PostgreSQL is not upgraded to 14 already. | | 16.10.1, 16.9.3, 16.8.5 | 13.14, 14.11 | 14.11 | 14.11 | | | 16.6.7, 16.7.5, 16.8.2 | 13.13, 14.10 | 14.10 | 14.10 | | @@ -48,7 +48,7 @@ Read more about update policies and warnings in the PostgreSQL | 15.10.8 | 13.11 | 13.11 | 12.12 | | | 15.6 | 12.12, 13.8 | 13.8 | 12.12 | For upgrades, you can manually upgrade to 13.8 following the [upgrade documentation](../../update/versions/gitlab_15_changes.md#linux-package-installations-2). | | 15.0 | 12.10, 13.6 | 13.6 | 12.10 | For upgrades, you can manually upgrade to 13.6 following the [upgrade documentation](../../update/versions/gitlab_15_changes.md#linux-package-installations-2). | -| 14.1 | 12.7, 13.3 | 12.7 | 12.7 | PostgreSQL 13 available for fresh installations if not using [Geo](../geo/index.md#requirements-for-running-geo) or [Patroni](../postgresql/_index.md#postgresql-replication-and-failover-for-linux-package-installations). | +| 14.1 | 12.7, 13.3 | 12.7 | 12.7 | PostgreSQL 13 available for fresh installations if not using [Geo](../geo/_index.md#requirements-for-running-geo) or [Patroni](../postgresql/_index.md#postgresql-replication-and-failover-for-linux-package-installations). | | 14.0 | 12.7 | 12.7 | 12.7 | HA installations with repmgr are no longer supported and are prevented from upgrading to Linux package 14.0 | | 13.8 | 11.9, 12.4 | 12.4 | 12.4 | Package upgrades automatically performed PostgreSQL upgrade for nodes that are not part of a Geo or HA cluster. | | 13.7 | 11.9, 12.4 | 12.4 | 11.9 | For upgrades users can manually upgrade to 12.4 following the [upgrade documentation](https://docs.gitlab.com/omnibus/settings/database.html#upgrade-packaged-postgresql-server). | diff --git a/doc/administration/packages/index.md b/doc/administration/packages/_index.md similarity index 100% rename from doc/administration/packages/index.md rename to doc/administration/packages/_index.md diff --git a/doc/administration/pages/index.md b/doc/administration/pages/_index.md similarity index 99% rename from doc/administration/pages/index.md rename to doc/administration/pages/_index.md index 79f91841d9b7..6cf791721b77 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/_index.md @@ -390,7 +390,7 @@ control over how the Pages daemon runs and serves content in your environment. |-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `pages_external_url` | The URL where GitLab Pages is accessible, including protocol (HTTP / HTTPS). If `https://` is used, additional configuration is required. See [Wildcard domains with TLS support](#wildcard-domains-with-tls-support) and [Custom domains with TLS support](#custom-domains-with-tls-support) for details. | | **`gitlab_pages[]`** | | -| `access_control` | Whether to enable [access control](index.md#access-control). | +| `access_control` | Whether to enable [access control](_index.md#access-control). | | `api_secret_key` | Full path to file with secret key used to authenticate with the GitLab API. Auto-generated when left unset. | | `artifacts_server` | Enable viewing [artifacts](../cicd/job_artifacts.md) in GitLab Pages. | | `artifacts_server_timeout` | Timeout (in seconds) for a proxied request to the artifacts server. | @@ -452,7 +452,7 @@ control over how the Pages daemon runs and serves content in your environment. | `pages_domain_removal_cron_worker` | Schedule for removing unverified custom GitLab Pages domains. | | `pages_path` | The directory on disk where pages are stored, defaults to `GITLAB-RAILS/shared/pages`. | | **`pages_nginx[]`** | | -| `enable` | Include a virtual host `server{}` block for Pages inside NGINX. Needed for NGINX to proxy traffic back to the Pages daemon. Set to `false` if the Pages daemon should directly receive all requests, for example, when using [custom domains](index.md#custom-domains). | +| `enable` | Include a virtual host `server{}` block for Pages inside NGINX. Needed for NGINX to proxy traffic back to the Pages daemon. Set to `false` if the Pages daemon should directly receive all requests, for example, when using [custom domains](_index.md#custom-domains). | | `FF_CONFIGURABLE_ROOT_DIR` | Feature flag to [customize the default folder](../../user/project/pages/introduction.md#customize-the-default-folder) (enabled by default). | | `FF_ENABLE_PLACEHOLDERS` | Feature flag for rewrites (enabled by default). See [Rewrites](../../user/project/pages/redirects.md#rewrites) for more information. | | `rate_limit_source_ip` | Rate limit per source IP in number of requests per second. Set to `0` to disable this feature. | diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md index 546b65f1f434..a567cd03ad56 100644 --- a/doc/administration/pages/source.md +++ b/doc/administration/pages/source.md @@ -15,7 +15,7 @@ Before attempting to enable GitLab Pages, first make sure you have This document explains how to configure GitLab Pages for self-compiled GitLab installations. -For more information about configuring GitLab Pages for Linux Package installations (recommended), see the [Linux package documentation](index.md). +For more information about configuring GitLab Pages for Linux Package installations (recommended), see the [Linux package documentation](_index.md). The advantage of using the Linux package installation is that it contains the latest supported version of GitLab Pages. diff --git a/doc/administration/pages/troubleshooting.md b/doc/administration/pages/troubleshooting.md index 57d7a0edd5a5..4676fffb70e2 100644 --- a/doc/administration/pages/troubleshooting.md +++ b/doc/administration/pages/troubleshooting.md @@ -272,7 +272,7 @@ If you see the following error: ERRO[0010] Failed to connect to the internal GitLab API after 0.50s error="failed to connect to internal Pages API: HTTP status: 401" ``` -If you are [Running GitLab Pages on a separate server](index.md#running-gitlab-pages-on-a-separate-server) +If you are [Running GitLab Pages on a separate server](_index.md#running-gitlab-pages-on-a-separate-server) you must copy the `/etc/gitlab/gitlab-secrets.json` file from the **GitLab server** to the **Pages server**. @@ -295,7 +295,7 @@ WARN[0010] Pages cannot communicate with an instance of the GitLab API. Please s ``` This can happen if your `gitlab-secrets.json` file is out of date between GitLab Rails and GitLab -Pages. Follow steps 8-10 of [Running GitLab Pages on a separate server](index.md#running-gitlab-pages-on-a-separate-server), +Pages. Follow steps 8-10 of [Running GitLab Pages on a separate server](_index.md#running-gitlab-pages-on-a-separate-server), in all of your GitLab Pages instances. ## Intermittent 502 errors when using an AWS Network Load Balancer and GitLab Pages @@ -329,16 +329,16 @@ This problem comes from the permissions of the GitLab Pages OAuth application. T 1. Under **Scopes**, ensure that the `api` scope is selected. 1. Save your changes. -When running a [separate Pages server](index.md#running-gitlab-pages-on-a-separate-server), +When running a [separate Pages server](_index.md#running-gitlab-pages-on-a-separate-server), this setting needs to be configured on the main GitLab server. ## Workaround in case no wildcard DNS entry can be set -If the wildcard DNS [prerequisite](index.md#prerequisites) can't be met, you can still use GitLab Pages in a limited fashion: +If the wildcard DNS [prerequisite](_index.md#prerequisites) can't be met, you can still use GitLab Pages in a limited fashion: 1. [Move](../../user/project/settings/migrate_projects.md#transfer-a-project-to-another-namespace) all projects you need to use Pages with into a single group namespace, for example `pages`. -1. Configure a [DNS entry](index.md#dns-configuration) without the `*.`-wildcard, for example `pages.example.io`. +1. Configure a [DNS entry](_index.md#dns-configuration) without the `*.`-wildcard, for example `pages.example.io`. 1. Configure `pages_external_url http://example.io/` in your `gitlab.rb` file. Omit the group namespace here, because it automatically is prepended by GitLab. @@ -406,7 +406,7 @@ the shared pages directory is mounted on a different path on the main GitLab ser GitLab Pages server. In that case, it's highly recommended you to configure -[object storage and migrate any existing pages data to it](index.md#object-storage-settings). +[object storage and migrate any existing pages data to it](_index.md#object-storage-settings). Alternatively, you can mount the GitLab Pages shared directory to the same path on both servers. @@ -423,7 +423,7 @@ To fix that: 1. Check your `gitlab.rb` file. If you have `gitlab_rails['pages_object_store_enabled']` enabled, but no bucket details have been configured, either: - - Configure object storage for your Pages deployments, following the [S3-compatible connection settings](index.md#s3-compatible-connection-settings) guide. + - Configure object storage for your Pages deployments, following the [S3-compatible connection settings](_index.md#s3-compatible-connection-settings) guide. - Store your deployments locally, by commenting out that line. 1. Save the changes you made to your `gitlab.rb` file, then [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). diff --git a/doc/administration/postgresql/upgrading_os.md b/doc/administration/postgresql/upgrading_os.md index fc0eec23dedd..546cc30883f8 100644 --- a/doc/administration/postgresql/upgrading_os.md +++ b/doc/administration/postgresql/upgrading_os.md @@ -6,7 +6,7 @@ title: Upgrading operating systems for PostgreSQL --- WARNING: -[Geo](../geo/index.md) cannot be used to migrate a PostgreSQL database from one operating system to another. If you attempt to do so, the secondary site may appear to be 100% replicated when in fact some data is not replicated, leading to data loss. This is because Geo depends on PostgreSQL streaming replication, which suffers from the limitations described in this document. Also see [Geo Troubleshooting - Check OS locale data compatibility](../geo/replication/troubleshooting/common.md#check-os-locale-data-compatibility). +[Geo](../geo/_index.md) cannot be used to migrate a PostgreSQL database from one operating system to another. If you attempt to do so, the secondary site may appear to be 100% replicated when in fact some data is not replicated, leading to data loss. This is because Geo depends on PostgreSQL streaming replication, which suffers from the limitations described in this document. Also see [Geo Troubleshooting - Check OS locale data compatibility](../geo/replication/troubleshooting/common.md#check-os-locale-data-compatibility). If you upgrade the operating system on which PostgreSQL runs, any [changes to locale data might corrupt your database indexes](https://wiki.postgresql.org/wiki/Locale_data_changes). @@ -345,7 +345,7 @@ primary site and the other secondary site: To provide users with read-only access to GitLab during the OS upgrade (partial downtime): -1. Enable [Maintenance Mode](../maintenance_mode/index.md) on the primary site instead of stopping +1. Enable [Maintenance Mode](../maintenance_mode/_index.md) on the primary site instead of stopping it. 1. Promote the secondary site but do not route users to it yet. 1. Perform the OS upgrade on the promoted site. diff --git a/doc/administration/raketasks/ldap.md b/doc/administration/raketasks/ldap.md index 800a70ee5111..13a384049bdf 100644 --- a/doc/administration/raketasks/ldap.md +++ b/doc/administration/raketasks/ldap.md @@ -156,7 +156,7 @@ sudo gitlab-rake gitlab:ldap:rename_provider[old_provider,new_provider] force=ye ## Secrets -GitLab can use [LDAP configuration secrets](../auth/ldap/index.md#use-encrypted-credentials) to read from an encrypted file. +GitLab can use [LDAP configuration secrets](../auth/ldap/_index.md#use-encrypted-credentials) to read from an encrypted file. The following Rake tasks are provided for updating the contents of the encrypted file. ### Show secret diff --git a/doc/administration/read_only_gitlab.md b/doc/administration/read_only_gitlab.md index 737cea330b8a..b7449dc4ba58 100644 --- a/doc/administration/read_only_gitlab.md +++ b/doc/administration/read_only_gitlab.md @@ -11,7 +11,7 @@ DETAILS: NOTE: The recommended method to place GitLab in a read-only state is to enable -[maintenance mode](maintenance_mode/index.md). +[maintenance mode](maintenance_mode/_index.md). In some cases, you might want to place GitLab under a read-only state. The configuration for doing so depends on your desired outcome. diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 11e514080673..bbc5a9e54b57 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -282,7 +282,7 @@ If you're using GitLab Pages with custom domain support you will need some additional port configurations. GitLab Pages requires a separate virtual IP address. Configure DNS to point the `pages_external_url` from `/etc/gitlab/gitlab.rb` at the new virtual IP address. See the -[GitLab Pages documentation](../pages/index.md) for more information. +[GitLab Pages documentation](../pages/_index.md) for more information. | LB Port | Backend Port | Protocol | | ------- | ------------- | --------- | @@ -291,7 +291,7 @@ GitLab Pages requires a separate virtual IP address. Configure DNS to point the - (*1*): The backend port for GitLab Pages depends on the `gitlab_pages['external_http']` and `gitlab_pages['external_https']` - setting. See [GitLab Pages documentation](../pages/index.md) for more details. + setting. See [GitLab Pages documentation](../pages/_index.md) for more details. - (*2*): Port 443 for GitLab Pages should always use the TCP protocol. Users can configure custom domains with custom SSL, which would not be possible if SSL was terminated at the load balancer. diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 2ebb619ba664..872938a1f6fa 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -284,7 +284,7 @@ If you're using GitLab Pages with custom domain support you will need some additional port configurations. GitLab Pages requires a separate virtual IP address. Configure DNS to point the `pages_external_url` from `/etc/gitlab/gitlab.rb` at the new virtual IP address. See the -[GitLab Pages documentation](../pages/index.md) for more information. +[GitLab Pages documentation](../pages/_index.md) for more information. | LB Port | Backend Port | Protocol | | ------- | ------------- | --------- | @@ -293,7 +293,7 @@ GitLab Pages requires a separate virtual IP address. Configure DNS to point the - (*1*): The backend port for GitLab Pages depends on the `gitlab_pages['external_http']` and `gitlab_pages['external_https']` - setting. See [GitLab Pages documentation](../pages/index.md) for more details. + setting. See [GitLab Pages documentation](../pages/_index.md) for more details. - (*2*): Port 443 for GitLab Pages should always use the TCP protocol. Users can configure custom domains with custom SSL, which would not be possible if SSL was terminated at the load balancer. diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 8763063c4420..e7dda045cc4d 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -183,7 +183,7 @@ If you're using GitLab Pages with custom domain support you will need some additional port configurations. GitLab Pages requires a separate virtual IP address. Configure DNS to point the `pages_external_url` from `/etc/gitlab/gitlab.rb` at the new virtual IP address. See the -[GitLab Pages documentation](../pages/index.md) for more information. +[GitLab Pages documentation](../pages/_index.md) for more information. | LB Port | Backend Port | Protocol | | ------- | ------------- | --------- | @@ -192,7 +192,7 @@ GitLab Pages requires a separate virtual IP address. Configure DNS to point the - (*1*): The backend port for GitLab Pages depends on the `gitlab_pages['external_http']` and `gitlab_pages['external_https']` - setting. See [GitLab Pages documentation](../pages/index.md) for more details. + setting. See [GitLab Pages documentation](../pages/_index.md) for more details. - (*2*): Port 443 for GitLab Pages should always use the TCP protocol. Users can configure custom domains with custom SSL, which would not be possible if SSL was terminated at the load balancer. diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index af7d66a4933a..5e21086a291b 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -272,7 +272,7 @@ If you're using GitLab Pages with custom domain support you will need some additional port configurations. GitLab Pages requires a separate virtual IP address. Configure DNS to point the `pages_external_url` from `/etc/gitlab/gitlab.rb` at the new virtual IP address. See the -[GitLab Pages documentation](../pages/index.md) for more information. +[GitLab Pages documentation](../pages/_index.md) for more information. | LB Port | Backend Port | Protocol | | ------- | ------------- | --------- | @@ -281,7 +281,7 @@ GitLab Pages requires a separate virtual IP address. Configure DNS to point the - (*1*): The backend port for GitLab Pages depends on the `gitlab_pages['external_http']` and `gitlab_pages['external_https']` - setting. See [GitLab Pages documentation](../pages/index.md) for more details. + setting. See [GitLab Pages documentation](../pages/_index.md) for more details. - (*2*): Port 443 for GitLab Pages should always use the TCP protocol. Users can configure custom domains with custom SSL, which would not be possible if SSL was terminated at the load balancer. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index e58c31626f09..8c3665b8a8fa 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -290,7 +290,7 @@ If you're using GitLab Pages with custom domain support you will need some additional port configurations. GitLab Pages requires a separate virtual IP address. Configure DNS to point the `pages_external_url` from `/etc/gitlab/gitlab.rb` at the new virtual IP address. See the -[GitLab Pages documentation](../pages/index.md) for more information. +[GitLab Pages documentation](../pages/_index.md) for more information. | LB Port | Backend Port | Protocol | | ------- | ------------- | --------- | @@ -299,7 +299,7 @@ GitLab Pages requires a separate virtual IP address. Configure DNS to point the - (*1*): The backend port for GitLab Pages depends on the `gitlab_pages['external_http']` and `gitlab_pages['external_https']` - setting. See [GitLab Pages documentation](../pages/index.md) for more details. + setting. See [GitLab Pages documentation](../pages/_index.md) for more details. - (*2*): Port 443 for GitLab Pages should always use the TCP protocol. Users can configure custom domains with custom SSL, which would not be possible if SSL was terminated at the load balancer. diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 21b5a0651aff..1ab4e4151faa 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -272,7 +272,7 @@ If you're using GitLab Pages with custom domain support you will need some additional port configurations. GitLab Pages requires a separate virtual IP address. Configure DNS to point the `pages_external_url` from `/etc/gitlab/gitlab.rb` at the new virtual IP address. See the -[GitLab Pages documentation](../pages/index.md) for more information. +[GitLab Pages documentation](../pages/_index.md) for more information. | LB Port | Backend Port | Protocol | | ------- | ------------- | --------- | @@ -281,7 +281,7 @@ GitLab Pages requires a separate virtual IP address. Configure DNS to point the - (*1*): The backend port for GitLab Pages depends on the `gitlab_pages['external_http']` and `gitlab_pages['external_https']` - setting. See [GitLab Pages documentation](../pages/index.md) for more details. + setting. See [GitLab Pages documentation](../pages/_index.md) for more details. - (*2*): Port 443 for GitLab Pages should always use the TCP protocol. Users can configure custom domains with custom SSL, which would not be possible if SSL was terminated at the load balancer. diff --git a/doc/administration/reference_architectures/_index.md b/doc/administration/reference_architectures/_index.md index 81dda332f8b5..c2632776eb2b 100644 --- a/doc/administration/reference_architectures/_index.md +++ b/doc/administration/reference_architectures/_index.md @@ -221,7 +221,7 @@ Cloud Native Hybrid is an alternative and more **advanced** setup compared to a ### GitLab Geo (Cross Regional Distribution / Disaster Recovery) -With [GitLab Geo](../geo/index.md), you can achieve distributed environments in +With [GitLab Geo](../geo/_index.md), you can achieve distributed environments in different regions with a full Disaster Recovery (DR) setup in place. GitLab Geo requires at least two separate environments: @@ -511,12 +511,12 @@ If you choose to use a third-party external service: 1. For optimal performance, enable [Database Load Balancing](../postgresql/database_load_balancing.md) with Read Replicas. Match the node counts to those used in standard Linux package deployments. This approach is particularly important for larger environments (more than 200 requests per second or 10,000+ users). 1. Database Connection Poolers are not required for this setup as the options vary per service. As a result, connection count configuration may need to be adjusted depending on the environment size. If Pooling is desired, a third party option needs to be explored. [Database Load Balancing](../postgresql/database_load_balancing.md) can also be used to spread the load accordingly. - + Ensure that if a pooler is included in a Cloud Provider service, it can handle the total load without bottlenecks. For example, Azure Database for PostgreSQL flexible server can optionally deploy a PgBouncer pooler in front of the database. However, PgBouncer is single threaded, which may cause bottlenecks under heavy load. To mitigate this issue, you can use database load balancing to distribute the pooler across multiple nodes. 1. The number of nodes required for HA may vary depending on the service. The requirements for one deployment may vary from those for Linux package installations. -1. To use [GitLab Geo](../geo/index.md), the service should support cross-region replication. +1. To use [GitLab Geo](../geo/_index.md), the service should support cross-region replication. #### Unsupported database services @@ -591,7 +591,7 @@ multiple data centers can negatively impact their functionality. This limitation applies to all potential GitLab environment setups, including Cloud Native Hybrid alternatives. -For deploying GitLab over multiple data centers or regions, we offer [GitLab Geo](../geo/index.md) as a comprehensive solution. +For deploying GitLab over multiple data centers or regions, we offer [GitLab Geo](../geo/_index.md) as a comprehensive solution. ## Validation and test results diff --git a/doc/administration/server_hooks.md b/doc/administration/server_hooks.md index 12bda58be88a..48bacd6b42a4 100644 --- a/doc/administration/server_hooks.md +++ b/doc/administration/server_hooks.md @@ -32,7 +32,7 @@ If you don't have access to the `gitaly` command, alternatives to server hooks i - [GitLab CI/CD](../ci/_index.md). - [Push rules](../user/project/repository/push_rules.md), for a user-configurable Git hook interface. -[Geo](geo/index.md) doesn't replicate server hooks to secondary nodes. +[Geo](geo/_index.md) doesn't replicate server hooks to secondary nodes. ## Set server hooks for a repository diff --git a/doc/administration/settings/sign_up_restrictions.md b/doc/administration/settings/sign_up_restrictions.md index af9b3b27e9d4..1c90758ea8a9 100644 --- a/doc/administration/settings/sign_up_restrictions.md +++ b/doc/administration/settings/sign_up_restrictions.md @@ -56,7 +56,7 @@ NOTE: This setting doesn't apply to LDAP or OmniAuth users. To enforce approvals for new users signing up using OmniAuth or LDAP, set `block_auto_created_users` to `true` in the [OmniAuth configuration](../../integration/omniauth.md#configure-common-settings) or -[LDAP configuration](../auth/ldap/index.md#basic-configuration-settings). +[LDAP configuration](../auth/ldap/_index.md#basic-configuration-settings). A [user cap](#user-cap) can also be used to enforce approvals for new users. ## Confirm user email @@ -243,7 +243,7 @@ semicolon, comma, or a new line. You can limit GitLab access to a subset of the LDAP users on your LDAP server. -See the [documentation on setting up an LDAP user filter](../auth/ldap/index.md#set-up-ldap-user-filter) for more information. +See the [documentation on setting up an LDAP user filter](../auth/ldap/_index.md#set-up-ldap-user-filter) for more information. ## Turn on administrator approval for role promotions diff --git a/doc/administration/settings/usage_statistics.md b/doc/administration/settings/usage_statistics.md index 3bf2b2816180..d55211d98a07 100644 --- a/doc/administration/settings/usage_statistics.md +++ b/doc/administration/settings/usage_statistics.md @@ -59,7 +59,7 @@ In the following table, you can see: | [Repository size limit](../settings/account_and_limit_settings.md#repository-size-limit) | GitLab 14.4 and later | | [Group access restriction by IP address](../../user/group/access_and_permissions.md#restrict-group-access-by-ip-address) | GitLab 14.4 and later | | [View description change history](../../user/discussions/_index.md#view-description-change-history) | GitLab 16.0 and later | -| [Maintenance mode](../maintenance_mode/index.md) | GitLab 16.0 and later | +| [Maintenance mode](../maintenance_mode/_index.md) | GitLab 16.0 and later | | [Configurable issue boards](../../user/project/issue_board.md#configurable-issue-boards) | GitLab 16.0 and later | | [Coverage-guided fuzz testing](../../user/application_security/coverage_fuzzing/index.md) | GitLab 16.0 and later | | [Password complexity requirements](../settings/sign_up_restrictions.md#password-complexity-requirements) | GitLab 16.0 and later | diff --git a/doc/administration/sidekiq/_index.md b/doc/administration/sidekiq/_index.md index 5427d61c25f4..e3060eec86bd 100644 --- a/doc/administration/sidekiq/_index.md +++ b/doc/administration/sidekiq/_index.md @@ -175,7 +175,7 @@ users and groups are not automatically synchronized. For more information about configuring LDAP for GitLab, see: -- [GitLab LDAP configuration documentation](../auth/ldap/index.md#configure-ldap) +- [GitLab LDAP configuration documentation](../auth/ldap/_index.md#configure-ldap) - [LDAP synchronization documentation](../auth/ldap/ldap_synchronization.md#adjust-ldap-user-sync-schedule) To enable LDAP with the synchronization worker for Sidekiq: diff --git a/doc/administration/silent_mode/index.md b/doc/administration/silent_mode/_index.md similarity index 100% rename from doc/administration/silent_mode/index.md rename to doc/administration/silent_mode/_index.md diff --git a/doc/administration/troubleshooting/_index.md b/doc/administration/troubleshooting/_index.md index 97e4a80b6c8c..3390f692a740 100644 --- a/doc/administration/troubleshooting/_index.md +++ b/doc/administration/troubleshooting/_index.md @@ -18,7 +18,7 @@ for in this list, you should search the documentation. ## Troubleshooting guides - [SSL](https://docs.gitlab.com/omnibus/settings/ssl/ssl_troubleshooting.html) -- [Geo](../geo/replication/troubleshooting/index.md) +- [Geo](../geo/replication/troubleshooting/_index.md) - [SAML](../../user/group/saml_sso/troubleshooting.md) - [Kubernetes cheat sheet](https://docs.gitlab.com/charts/troubleshooting/kubernetes_cheat_sheet.html) - [Linux cheat sheet](linux_cheat_sheet.md) diff --git a/doc/administration/troubleshooting/postgresql.md b/doc/administration/troubleshooting/postgresql.md index 64da8226714b..3ae850660e64 100644 --- a/doc/administration/troubleshooting/postgresql.md +++ b/doc/administration/troubleshooting/postgresql.md @@ -322,7 +322,7 @@ PANIC: could not write to file 'pg_xlog/xlogtemp.123': No space left on device When troubleshooting problems with Geo, you should: - Review [common Geo errors](../geo/replication/troubleshooting/common.md#fixing-common-errors). -- [Review your Geo configuration](../geo/replication/troubleshooting/index.md), including: +- [Review your Geo configuration](../geo/replication/troubleshooting/_index.md), including: - Reconfiguring hosts and ports. - Reviewing and fixing the user and password mappings. diff --git a/doc/administration/wikis/index.md b/doc/administration/wikis/_index.md similarity index 100% rename from doc/administration/wikis/index.md rename to doc/administration/wikis/_index.md diff --git a/doc/api/graphql/audit_event_streaming_instances.md b/doc/api/graphql/audit_event_streaming_instances.md index 3870b8bb7209..244cf1aec184 100644 --- a/doc/api/graphql/audit_event_streaming_instances.md +++ b/doc/api/graphql/audit_event_streaming_instances.md @@ -289,7 +289,7 @@ Event type filters are removed if: Manage Google Cloud Logging destinations for an entire instance. -Before setting up Google Cloud Logging streaming audit events, you must satisfy [the prerequisites](../../administration/audit_event_streaming/index.md#prerequisites). +Before setting up Google Cloud Logging streaming audit events, you must satisfy [the prerequisites](../../administration/audit_event_streaming/_index.md#prerequisites). ### Add a new Google Cloud Logging destination diff --git a/doc/api/packages.md b/doc/api/packages.md index 2555af4d6d7e..eaa2da09bfbd 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -11,7 +11,7 @@ DETAILS: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349418) support for [GitLab CI/CD job token](../ci/jobs/ci_job_token.md) authentication for the project-level API in GitLab 15.3. -The API documentation of [GitLab Packages](../administration/packages/index.md). +The API documentation of [GitLab Packages](../administration/packages/_index.md). ## List packages diff --git a/doc/api/pages.md b/doc/api/pages.md index 09ba777166d8..260453de2387 100644 --- a/doc/api/pages.md +++ b/doc/api/pages.md @@ -11,7 +11,7 @@ DETAILS: Endpoints for managing [GitLab Pages](../user/project/pages/index.md). -The GitLab Pages feature must be enabled to use these endpoints. Find out more about [administering](../administration/pages/index.md) and [using](../user/project/pages/index.md) the feature. +The GitLab Pages feature must be enabled to use these endpoints. Find out more about [administering](../administration/pages/_index.md) and [using](../user/project/pages/index.md) the feature. ## Unpublish Pages diff --git a/doc/api/pages_domains.md b/doc/api/pages_domains.md index 82533648b875..b876ca713969 100644 --- a/doc/api/pages_domains.md +++ b/doc/api/pages_domains.md @@ -11,7 +11,7 @@ DETAILS: Endpoints for connecting custom domains and TLS certificates in [GitLab Pages](../user/project/pages/index.md). -The GitLab Pages feature must be enabled to use these endpoints. Find out more about [administering](../administration/pages/index.md) and [using](../user/project/pages/index.md) the feature. +The GitLab Pages feature must be enabled to use these endpoints. Find out more about [administering](../administration/pages/_index.md) and [using](../user/project/pages/index.md) the feature. ## List all Pages domains diff --git a/doc/api/settings.md b/doc/api/settings.md index e3e2d091ce2a..7743d30da490 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -662,7 +662,7 @@ to configure other related settings. These requirements are | `signin_enabled` | string | no | (Deprecated: Use `password_authentication_enabled_for_web` instead) Flag indicating if password authentication is enabled for the web interface. | | `signup_enabled` | boolean | no | Enable registration. Default is `true`. | | `silent_admin_exports_enabled` | boolean | no | Enable [Silent admin exports](../administration/settings/import_and_export_settings.md#enable-silent-admin-exports). Default is `false`. | -| `silent_mode_enabled` | boolean | no | Enable [Silent mode](../administration/silent_mode/index.md). Default is `false`. | +| `silent_mode_enabled` | boolean | no | Enable [Silent mode](../administration/silent_mode/_index.md). Default is `false`. | | `slack_app_enabled` | boolean | no | (**If enabled, requires:** `slack_app_id`, `slack_app_secret`, `slack_app_signing_secret`, and `slack_app_verification_token`) Enable the GitLab for Slack app. | | `slack_app_id` | string | required by: `slack_app_enabled` | The client ID of the GitLab for Slack app. | | `slack_app_secret` | string | required by: `slack_app_enabled` | The client secret of the GitLab for Slack app. Used for authenticating OAuth requests from the app. | diff --git a/doc/ci/jobs/job_artifacts.md b/doc/ci/jobs/job_artifacts.md index 4338a792b9b6..85a51fad40bd 100644 --- a/doc/ci/jobs/job_artifacts.md +++ b/doc/ci/jobs/job_artifacts.md @@ -281,9 +281,9 @@ from: - A job's detail page. On the right of the page, select **Browse**. - The **Artifacts** page. On the right of the job, select **Browse** (**{folder-open}**). -If [GitLab Pages](../../administration/pages/index.md) is enabled globally, even if it is disabled in the project settings, +If [GitLab Pages](../../administration/pages/_index.md) is enabled globally, even if it is disabled in the project settings, you can preview some artifacts file extensions directly in your browser. If the project is internal or private, -you must enable [GitLab Pages access control](../../administration/pages/index.md#access-control) to enable the preview. +you must enable [GitLab Pages access control](../../administration/pages/_index.md#access-control) to enable the preview. The following extensions are supported: diff --git a/doc/ci/yaml/_index.md b/doc/ci/yaml/_index.md index 2c06f8a59edd..aa2f770230b2 100644 --- a/doc/ci/yaml/_index.md +++ b/doc/ci/yaml/_index.md @@ -1413,7 +1413,7 @@ test: - Glob patterns are unsupported. - If a directory is specified and there is more than one file in the directory, the link is to the job [artifacts browser](../jobs/job_artifacts.md#download-job-artifacts). -- If [GitLab Pages](../../administration/pages/index.md) is enabled, GitLab automatically +- If [GitLab Pages](../../administration/pages/_index.md) is enabled, GitLab automatically renders the artifacts when the artifacts is a single file with one of these extensions: - `.html` or `.htm` - `.txt` diff --git a/doc/development/architecture.md b/doc/development/architecture.md index 851c755bf089..23749e6f2af4 100644 --- a/doc/development/architecture.md +++ b/doc/development/architecture.md @@ -553,7 +553,7 @@ You can use it to sync deployments onto your Kubernetes cluster. #### GitLab Pages - Configuration: - - [Omnibus](../administration/pages/index.md) + - [Omnibus](../administration/pages/_index.md) - [Charts](https://gitlab.com/gitlab-org/charts/gitlab/-/issues/37) - [Source](../install/installation.md#install-gitlab-pages) - [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/main/doc/howto/pages.md) @@ -859,7 +859,7 @@ Starting with GitLab 13.0, Puma is the default web server. #### LDAP Authentication - Configuration: - - [Omnibus](../administration/auth/ldap/index.md) + - [Omnibus](../administration/auth/ldap/_index.md) - [Charts](https://docs.gitlab.com/charts/charts/globals.html#ldap) - [Source](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/gitlab.yml.example) - [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/main/doc/howto/ldap.md) diff --git a/doc/development/audit_event_guide/_index.md b/doc/development/audit_event_guide/_index.md index f4300d77a201..f2d37dcdf1e0 100644 --- a/doc/development/audit_event_guide/_index.md +++ b/doc/development/audit_event_guide/_index.md @@ -248,7 +248,7 @@ bundle exec rake gitlab:audit_event_types:check_docs ## Event streaming All events where the entity is a `Group` or `Project` are recorded in the audit log, and also streamed to one or more -[event streaming destinations](../../administration/audit_event_streaming/index.md). When the entity is a: +[event streaming destinations](../../administration/audit_event_streaming/_index.md). When the entity is a: - `Group`, events are streamed to the group's root ancestor's event streaming destinations. - `Project`, events are streamed to the project's root ancestor's event streaming destinations. diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index 0f87c2ac42be..1355e64bedef 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -200,7 +200,7 @@ To reach the definition of done, the merge request must create no regressions an - Verified as working in production on GitLab.com. - Verified as working for self-managed instances. -- Verified as supporting [Geo](../../administration/geo/index.md) through the [self-service framework](../geo/framework.md). For more information, see [Geo is a requirement in the definition of done](../geo/framework.md#geo-is-a-requirement-in-the-definition-of-done). +- Verified as supporting [Geo](../../administration/geo/_index.md) through the [self-service framework](../geo/framework.md). For more information, see [Geo is a requirement in the definition of done](../geo/framework.md#geo-is-a-requirement-in-the-definition-of-done). If a regression occurs, we prefer you revert the change. Your contribution is *incomplete* until you have made sure it meets all of these diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md index f66d1d9622fe..fdf52c4b652e 100644 --- a/doc/development/ee_features.md +++ b/doc/development/ee_features.md @@ -193,7 +193,7 @@ Use the following questions to guide you: - Based on the plan you choose to use the feature in, add the feature identifier to `PREMIUM_FEATURES` or `ULTIMATE_FEATURES`. 1. Will this feature be available globally (system-wide for the GitLab instance)? - - Features such as [Geo](../administration/geo/index.md) and + - Features such as [Geo](../administration/geo/_index.md) and [Database Load Balancing](../administration/postgresql/database_load_balancing.md) are used by the entire instance and cannot be restricted to individual user namespaces. These features are defined in the instance license. Add these features to `GLOBAL_FEATURES`. diff --git a/doc/development/geo/proxying.md b/doc/development/geo/proxying.md index 899885e1adbb..fa1e8d85594d 100644 --- a/doc/development/geo/proxying.md +++ b/doc/development/geo/proxying.md @@ -10,7 +10,7 @@ secondary see a read-write UI, and are able to do all operations that they can d ## High-level components -Proxying of GitLab UI and API HTTP requests is handled by the [`gitlab-workhorse`](../architecture.md#gitlab-workhorse) component. Traffic usually sent to the Rails application on the Geo secondary site is proxied to the [internal URL](../../administration/geo/index.md#internal-url) of the primary Geo site instead. +Proxying of GitLab UI and API HTTP requests is handled by the [`gitlab-workhorse`](../architecture.md#gitlab-workhorse) component. Traffic usually sent to the Rails application on the Geo secondary site is proxied to the [internal URL](../../administration/geo/_index.md#internal-url) of the primary Geo site instead. Proxying of Git over HTTP requests is handled by the [`gitlab-workhorse`](../architecture.md#gitlab-workhorse) component, but the decision to proxy or not is handled by the Rails application, taking into account whether the request is push or pull, and whether the desired Git data is up-to-date. diff --git a/doc/development/internal_analytics/service_ping/_index.md b/doc/development/internal_analytics/service_ping/_index.md index 535b3a6d1afa..778cffeebba5 100644 --- a/doc/development/internal_analytics/service_ping/_index.md +++ b/doc/development/internal_analytics/service_ping/_index.md @@ -128,7 +128,7 @@ sequenceDiagram ### On a Geo secondary site -We also collect metrics specific to [Geo](../../../administration/geo/index.md) secondary sites to send with Service Ping. +We also collect metrics specific to [Geo](../../../administration/geo/_index.md) secondary sites to send with Service Ping. 1. The [Geo secondary service ping cron job](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/workers/geo/secondary_usage_data_cron_worker.rb) is set in Sidekiq to run weekly. 1. When the cron job runs, it calls [`SecondaryUsageData.update_metrics!`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/geo/secondary_usage_data.rb#L33). This collects the relevant metrics from Prometheus and stores the data in the Geo secondary tracking database for transmission to the primary site during a [Geo node status update](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/geo_node_status.rb#L105). diff --git a/doc/development/packages/new_format_development.md b/doc/development/packages/new_format_development.md index 174ee265247b..8feff738d3f5 100644 --- a/doc/development/packages/new_format_development.md +++ b/doc/development/packages/new_format_development.md @@ -5,7 +5,7 @@ info: Any user with at least the Maintainer role can merge updates to this conte title: Developing support for a new package format --- -This document guides you through adding support to GitLab for a new a [package management system](../../administration/packages/index.md). +This document guides you through adding support to GitLab for a new a [package management system](../../administration/packages/_index.md). See the already supported formats in the [Packages and registries documentation](../../user/packages/index.md) diff --git a/doc/development/testing_guide/end_to_end/running_tests/running_tests_that_require_special_setup.md b/doc/development/testing_guide/end_to_end/running_tests/running_tests_that_require_special_setup.md index 09207e33d5b3..bc6d089ab6a6 100644 --- a/doc/development/testing_guide/end_to_end/running_tests/running_tests_that_require_special_setup.md +++ b/doc/development/testing_guide/end_to_end/running_tests/running_tests_that_require_special_setup.md @@ -379,7 +379,7 @@ These tests spin up a Docker container [(`osixia/openldap`)](https://hub.docker. The container uses fixtures [checked into the GitLab-QA repository](https://gitlab.com/gitlab-org/gitlab-qa/-/tree/9ffb9ad3be847a9054967d792d6772a74220fb42/fixtures/ldap) to create base data such as users and groups including the administrator group. The password for [all users](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/9ffb9ad3be847a9054967d792d6772a74220fb42/fixtures/ldap/2_add_users.ldif) including [the `tanuki` user](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/9ffb9ad3be847a9054967d792d6772a74220fb42/fixtures/ldap/tanuki.ldif) is `password`. -A GitLab instance is also created in a Docker container based on our [LDAP setup](../../../../administration/auth/ldap/index.md) documentation. +A GitLab instance is also created in a Docker container based on our [LDAP setup](../../../../administration/auth/ldap/_index.md) documentation. Tests that are tagged `:ldap_tls` enable TLS on GitLab using the certificate [checked into the GitLab-QA repository](https://gitlab.com/gitlab-org/gitlab-qa/-/tree/9ffb9ad3be847a9054967d792d6772a74220fb42/tls_certificates/gitlab). diff --git a/doc/install/aws/_index.md b/doc/install/aws/_index.md index b66a6766ec31..8f6e4cd54140 100644 --- a/doc/install/aws/_index.md +++ b/doc/install/aws/_index.md @@ -919,7 +919,7 @@ to request additional material: - [Scaling GitLab](../../administration/reference_architectures/_index.md): GitLab supports several different types of clustering. -- [Geo replication](../../administration/geo/index.md): +- [Geo replication](../../administration/geo/_index.md): Geo is the solution for widely distributed development teams. - [Linux package](https://docs.gitlab.com/omnibus/) - Everything you must know about administering your GitLab instance. diff --git a/doc/install/google_cloud_platform/_index.md b/doc/install/google_cloud_platform/_index.md index c37eecb12110..16af93502896 100644 --- a/doc/install/google_cloud_platform/_index.md +++ b/doc/install/google_cloud_platform/_index.md @@ -135,7 +135,7 @@ SAML, and Kerberos. Here are some documents you might be interested in reading: - [Linux package documentation](https://docs.gitlab.com/omnibus/) - [Integration documentation](../../integration/index.md) -- [GitLab Pages configuration](../../administration/pages/index.md) +- [GitLab Pages configuration](../../administration/pages/_index.md) - [GitLab container registry configuration](../../administration/packages/container_registry.md) <!-- ## Troubleshooting diff --git a/doc/install/installation.md b/doc/install/installation.md index 1d887377cdf9..26dcb436a53a 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -975,7 +975,7 @@ sudo editor /etc/nginx/sites-available/gitlab If you intend to enable GitLab Pages, there is a separate NGINX configuration you need to use. Read all about the needed configuration at the -[GitLab Pages administration guide](../administration/pages/index.md). +[GitLab Pages administration guide](../administration/pages/_index.md). If you want to use HTTPS, replace the `gitlab` NGINX configuration with `gitlab-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details. diff --git a/doc/install/next_steps.md b/doc/install/next_steps.md index 892d7827a54e..29645a44f189 100644 --- a/doc/install/next_steps.md +++ b/doc/install/next_steps.md @@ -42,7 +42,7 @@ installation. ## Authentication -- [LDAP](../administration/auth/ldap/index.md): Configure LDAP to be used as +- [LDAP](../administration/auth/ldap/_index.md): Configure LDAP to be used as an authentication mechanism for GitLab. - [SAML and OAuth](../integration/omniauth.md): Authenticate via online services like Okta, Google, Azure AD, and more. @@ -70,7 +70,7 @@ installation. - [Scaling GitLab](../administration/reference_architectures/_index.md): GitLab supports several different types of clustering. -- [Geo replication](../administration/geo/index.md): +- [Geo replication](../administration/geo/_index.md): Geo is the solution for widely distributed development teams. ## Install the product documentation diff --git a/doc/install/postgresql_extensions.md b/doc/install/postgresql_extensions.md index a74036ee6719..a3d04b04ff70 100644 --- a/doc/install/postgresql_extensions.md +++ b/doc/install/postgresql_extensions.md @@ -20,7 +20,7 @@ You must load the following extensions into the main GitLab database (defaults t | `btree_gist` | 13.1 | | `plpgsql` | 11.7 | -If you are using [GitLab Geo](../administration/geo/index.md), you must load the following +If you are using [GitLab Geo](../administration/geo/_index.md), you must load the following extensions into all secondary tracking databases (defaults to `gitlabhq_geo_production`): | Extension | Minimum GitLab version | diff --git a/doc/install/requirements.md b/doc/install/requirements.md index eea03ea28988..7c431b16cdc6 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -80,12 +80,12 @@ For more information, see [managing PostgreSQL extensions](postgresql_extensions ### GitLab Geo -For [GitLab Geo](../administration/geo/index.md), you should use the Linux package or +For [GitLab Geo](../administration/geo/_index.md), you should use the Linux package or [validated cloud providers](../administration/reference_architectures/_index.md#recommended-cloud-providers-and-services) to install GitLab. Compatibility with other external databases is not guaranteed. -For more information, see [requirements for running Geo](../administration/geo/index.md#requirements-for-running-geo). +For more information, see [requirements for running Geo](../administration/geo/_index.md#requirements-for-running-geo). ### Locale compatibility @@ -103,7 +103,7 @@ For more information, see [upgrading operating systems for PostgreSQL](../admini ### GitLab schemas -You should create or use databases exclusively for GitLab, [Geo](../administration/geo/index.md), +You should create or use databases exclusively for GitLab, [Geo](../administration/geo/_index.md), [Gitaly Cluster](../administration/gitaly/praefect.md), or other components. Do not create or modify databases, schemas, users, or other properties except when you follow: diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md index 45649e67a641..ba1a1a3fd455 100644 --- a/doc/integration/kerberos.md +++ b/doc/integration/kerberos.md @@ -165,12 +165,12 @@ knowledge can be a security risk. ## Link Kerberos and LDAP accounts together -If your users sign in with Kerberos, but you also have [LDAP integration](../administration/auth/ldap/index.md) +If your users sign in with Kerberos, but you also have [LDAP integration](../administration/auth/ldap/_index.md) enabled, your users are linked to their LDAP accounts on their first sign-in. For this to work, some prerequisites must be met: The Kerberos username must match the LDAP user's UID. You can choose which LDAP -attribute is used as the UID in the GitLab [LDAP configuration](../administration/auth/ldap/index.md#configure-ldap) +attribute is used as the UID in the GitLab [LDAP configuration](../administration/auth/ldap/_index.md#configure-ldap) but for Active Directory, this should be `sAMAccountName`. The Kerberos realm must match the domain part of the LDAP user's Distinguished diff --git a/doc/integration/omniauth.md b/doc/integration/omniauth.md index 5f84155320a7..54cab0c3057c 100644 --- a/doc/integration/omniauth.md +++ b/doc/integration/omniauth.md @@ -46,7 +46,7 @@ configure the settings that are common for all providers. | ------ | ----------- | | `allow_bypass_two_factor` | Allows users to sign in with the specified providers without two-factor authentication (2FA). Can be set to `true`, `false`, or an array of providers. For more information, see [Bypass two-factor authentication](#bypass-two-factor-authentication). | | `allow_single_sign_on` | Enables the automatic creation of accounts when signing in with OmniAuth. Can be set to `true`, `false` or an array of providers. For provider names, see the [supported providers table](#supported-providers). When `false`, signing in using your OmniAuth provider account without a pre-existing GitLab account is not allowed. You must create a GitLab account first, and then connect it to your OmniAuth provider account through your profile settings. | -| `auto_link_ldap_user` | Creates an LDAP identity in GitLab for users that are created through an OmniAuth provider. To enable this setting, you must have [LDAP integration](../administration/auth/ldap/index.md) enabled. Requires the `uid` of the user to be the same in both LDAP and the OmniAuth provider. | +| `auto_link_ldap_user` | Creates an LDAP identity in GitLab for users that are created through an OmniAuth provider. To enable this setting, you must have [LDAP integration](../administration/auth/ldap/_index.md) enabled. Requires the `uid` of the user to be the same in both LDAP and the OmniAuth provider. | | `auto_link_saml_user` | Allows users authenticating through a SAML provider to be automatically linked to a current GitLab user if their emails match. To enable this setting, you must have SAML integration enabled. | | `auto_link_user` | Allows users authenticating through an OmniAuth provider to be automatically linked to a current GitLab user if their emails match. Can be set to `true`, `false`, or an array of providers. For provider names, see the [supported providers table](#supported-providers). | | `auto_sign_in_with_provider` | Enables users to use a single provider name to automatically sign in. This must match the name of the provider, such as `saml` or `google_oauth2`. To prevent an infinite sign-in loop, users must sign out of their identity provider accounts before signing out of GitLab. There are ongoing feature enhancements like [SAML](https://gitlab.com/gitlab-org/gitlab/-/issues/14414) to implement federated sign out for supported OmniAuth providers. | diff --git a/doc/integration/saml.md b/doc/integration/saml.md index 5a3045f707cc..50ee805ab152 100644 --- a/doc/integration/saml.md +++ b/doc/integration/saml.md @@ -3220,7 +3220,7 @@ As a multi-tenant solution, group SAML on GitLab Self-Managed is limited compare to the recommended [instance-wide SAML](saml.md). Use instance-wide SAML to take advantage of: -- [LDAP compatibility](../administration/auth/ldap/index.md). +- [LDAP compatibility](../administration/auth/ldap/_index.md). - [LDAP Group Sync](../user/group/access_and_permissions.md#manage-group-memberships-with-ldap). - [Required groups](#required-groups). - [Administrator groups](#administrator-groups). diff --git a/doc/raketasks/_index.md b/doc/raketasks/_index.md index 79d79d64f257..7541c9bc6cb5 100644 --- a/doc/raketasks/_index.md +++ b/doc/raketasks/_index.md @@ -33,7 +33,7 @@ The following Rake tasks are available for use with GitLab: | [Import large project exports](../administration/raketasks/project_import_export.md#import-large-projects) | Import large GitLab [project exports](../user/project/settings/import_export.md). | | [Incoming email](../administration/raketasks/incoming_email.md) | Incoming email-related tasks. | | [Integrity checks](../administration/raketasks/check.md) | Check the integrity of repositories, files, LDAP, and more. | -| [LDAP maintenance](../administration/raketasks/ldap.md) | [LDAP](../administration/auth/ldap/index.md)-related tasks. | +| [LDAP maintenance](../administration/raketasks/ldap.md) | [LDAP](../administration/auth/ldap/_index.md)-related tasks. | | [Praefect Rake tasks](../administration/raketasks/praefect.md) | [Praefect](../administration/gitaly/praefect.md)-related tasks. | | [Project import/export](../administration/raketasks/project_import_export.md) | Prepare for [project exports and imports](../user/project/settings/import_export.md). | | [Sidekiq job migration](../administration/sidekiq/sidekiq_job_migration.md) | Migrate Sidekiq jobs scheduled for future dates to a new queue. | diff --git a/doc/security/_index.md b/doc/security/_index.md index 4056a20acf2e..df8b0f3fa8a8 100644 --- a/doc/security/_index.md +++ b/doc/security/_index.md @@ -78,7 +78,7 @@ GitLab Self-Managed customers and administrators are responsible for the securit - [Review Runner job logs information](../administration/cicd/job_logs.md). - [How to use correlation ID to trace logs](../administration/logs/tracing_correlation_id.md). - [Logging configuration and access](https://docs.gitlab.com/omnibus/settings/logs.html). -- [How to configure audit event streaming](../administration/audit_event_streaming/index.md). +- [How to configure audit event streaming](../administration/audit_event_streaming/_index.md). - [Providing assistance to GitLab.com customers during customer-based security incidents](https://handbook.gitlab.com/handbook/security/customer-requests/#conditions-and-requirements). ## Response diff --git a/doc/security/hardening_nist_800_53.md b/doc/security/hardening_nist_800_53.md index 7224c93fe6a2..368c6db47075 100644 --- a/doc/security/hardening_nist_800_53.md +++ b/doc/security/hardening_nist_800_53.md @@ -93,7 +93,7 @@ GitLab Self-Managed. GitLab provides resources for configuring various identity providers and protocols, including -- [LDAP](../administration/auth/ldap/index.md) +- [LDAP](../administration/auth/ldap/_index.md) - [SAML](../integration/saml.md) @@ -273,7 +273,7 @@ Information and Event Management (SIEM) solution. #### Event Types -GitLab outlines the [configurable audit event log types](../administration/audit_event_streaming/index.md), +GitLab outlines the [configurable audit event log types](../administration/audit_event_streaming/_index.md), which can be streamed and/or saved to a database. Administrators are able to configure the events that they'd like captured for their GitLab instance. @@ -502,7 +502,7 @@ including: GitLab Geo GitLab Geo is likely to be a critical component of any implementation -pursuing compliance with NIST 800-53. It is important to review [the available documentation](../administration/geo/index.md) +pursuing compliance with NIST 800-53. It is important to review [the available documentation](../administration/geo/_index.md) to ensure that Geo is configured appropriately for each use case. Implementing Geo provides the following benefits: @@ -548,9 +548,9 @@ Additional Geo Resources: - [Setting up Geo](../administration/geo/setup/_index.md) -- [Requirements for running Geo](../administration/geo/index.md#requirements-for-running-geo) +- [Requirements for running Geo](../administration/geo/_index.md#requirements-for-running-geo) -- [Geo Limitations](../administration/geo/index.md) +- [Geo Limitations](../administration/geo/_index.md) - [Geo Disaster Recovery Steps](../administration/geo/disaster_recovery/_index.md) diff --git a/doc/security/rate_limits.md b/doc/security/rate_limits.md index 84dd7a7d234a..25f144ce3f5b 100644 --- a/doc/security/rate_limits.md +++ b/doc/security/rate_limits.md @@ -47,7 +47,7 @@ You can set these rate limits in the **Admin** area of your instance: - [Rate limits on Git SSH operations](../administration/settings/rate_limits_on_git_ssh_operations.md) - [Files API rate limits](../administration/settings/files_api_rate_limits.md) - [Deprecated API rate limits](../administration/settings/deprecated_api_rate_limits.md) -- [GitLab Pages rate limits](../administration/pages/index.md#rate-limits) +- [GitLab Pages rate limits](../administration/pages/_index.md#rate-limits) - [Pipeline rate limits](../administration/settings/rate_limit_on_pipelines_creation.md) - [Incident management rate limits](../administration/settings/incident_management_rate_limits.md) - [Projects API rate limits](../administration/settings/rate_limit_on_projects_api.md) diff --git a/doc/security/responding_to_security_incidents.md b/doc/security/responding_to_security_incidents.md index 3f29afd2d73c..96a8b9aa920b 100644 --- a/doc/security/responding_to_security_incidents.md +++ b/doc/security/responding_to_security_incidents.md @@ -199,4 +199,4 @@ You can also consider implementing abuse rate limiting as detailed in [Git abuse GitLab SIRT maintains an active repository of detections in the [GitLab SIRT public project](https://gitlab.com/gitlab-com/gl-security/security-operations/gitlab-sirt-public/automated-incident-response/-/tree/main/detections). -The detections in this repository are based on the audit events and in the general Sigma rule format. You can use sigma rule converter to get the rules in your desired format. Please refer to the repository for more information about Sigma format and tools related to it . Make sure you have GitLab audit logs ingested to your SIEM. You should follow the [audit event streaming guide](../administration/audit_event_streaming/index.md) to stream audit events to your desired destination. +The detections in this repository are based on the audit events and in the general Sigma rule format. You can use sigma rule converter to get the rules in your desired format. Please refer to the repository for more information about Sigma format and tools related to it . Make sure you have GitLab audit logs ingested to your SIEM. You should follow the [audit event streaming guide](../administration/audit_event_streaming/_index.md) to stream audit events to your desired destination. diff --git a/doc/solutions/cloud/aws/gitlab_aws_integration.md b/doc/solutions/cloud/aws/gitlab_aws_integration.md index 53e0df410736..cf4bb79cfe40 100644 --- a/doc/solutions/cloud/aws/gitlab_aws_integration.md +++ b/doc/solutions/cloud/aws/gitlab_aws_integration.md @@ -143,7 +143,7 @@ Top-level groups on GitLab.com are also known as "Namespaces" and naming one aft ### User authentication and authorization between GitLab and AWS - [SAML SSO for GitLab.com groups](../../../user/group/saml_sso/index.md) `[GitLab Configuration]` - GitLab.com only -- [Integrate LDAP with GitLab](../../../administration/auth/ldap/index.md) `[GitLab Configuration]` - Self-managed only +- [Integrate LDAP with GitLab](../../../administration/auth/ldap/_index.md) `[GitLab Configuration]` - Self-managed only ### Runner workload authentication and authorization integration diff --git a/doc/subscriptions/bronze_starter.md b/doc/subscriptions/bronze_starter.md index e193944c8815..1ea982e7766f 100644 --- a/doc/subscriptions/bronze_starter.md +++ b/doc/subscriptions/bronze_starter.md @@ -50,7 +50,7 @@ the tiers are no longer mentioned in GitLab documentation: [all groups programmatically](../administration/auth/ldap/ldap_synchronization.md#group-sync), [group sync schedule](../administration/auth/ldap/ldap_synchronization.md#adjust-ldap-group-sync-schedule), and [all groups manually](../administration/auth/ldap/ldap-troubleshooting.md#sync-all-groups) - - [Configuration settings](../administration/auth/ldap/index.md#ldap-sync-configuration-settings) + - [Configuration settings](../administration/auth/ldap/_index.md#ldap-sync-configuration-settings) - Users: [all users](../administration/auth/ldap/ldap_synchronization.md#user-sync), [administrators](../administration/auth/ldap/ldap_synchronization.md#administrator-sync), [user sync schedule](../administration/auth/ldap/ldap_synchronization.md#adjust-ldap-user-sync-schedule) diff --git a/doc/subscriptions/gitlab_dedicated/_index.md b/doc/subscriptions/gitlab_dedicated/_index.md index 9b1d63cbc4ff..72e11bf09b2f 100644 --- a/doc/subscriptions/gitlab_dedicated/_index.md +++ b/doc/subscriptions/gitlab_dedicated/_index.md @@ -139,7 +139,7 @@ You can control access to your Pages website with: GitLab Pages for Dedicated: - Is enabled by default. -- Only works in the primary site if [Geo](../../administration/geo/index.md) is enabled. +- Only works in the primary site if [Geo](../../administration/geo/_index.md) is enabled. - Is not included as part of instance migrations to GitLab Dedicated. The following GitLab Pages features are not available for GitLab Dedicated: diff --git a/doc/subscriptions/self_managed/_index.md b/doc/subscriptions/self_managed/_index.md index b8c36e6a6650..eb0051b392af 100644 --- a/doc/subscriptions/self_managed/_index.md +++ b/doc/subscriptions/self_managed/_index.md @@ -176,7 +176,7 @@ You can trigger a manual update of the daily and historical billable users in yo Managing the number of users against the number of subscription seats can be difficult: -- If [LDAP is integrated with GitLab](../../administration/auth/ldap/index.md), anyone +- If [LDAP is integrated with GitLab](../../administration/auth/ldap/_index.md), anyone in the configured domain can sign up for a GitLab account. This can result in an unexpected bill at time of renewal. - If sign-up is turned on in your instance, anyone who can access the instance can @@ -186,7 +186,7 @@ GitLab has several features to help you manage the number of users. You can: - [Require administrator approval for new sign ups](../../administration/settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups). - Automatically block new users, either through - [LDAP](../../administration/auth/ldap/index.md#basic-configuration-settings) or + [LDAP](../../administration/auth/ldap/_index.md#basic-configuration-settings) or [OmniAuth](../../integration/omniauth.md#configure-common-settings). - [Limit the number of billable users](../../administration/settings/sign_up_restrictions.md#user-cap) who can sign up or be added to a subscription without administrator approval. diff --git a/doc/update/_index.md b/doc/update/_index.md index 9ce950ff5cb4..f549c800369e 100644 --- a/doc/update/_index.md +++ b/doc/update/_index.md @@ -36,7 +36,7 @@ To upgrade GitLab: You must spread out upgrades between major and minor releases to allow time for background migrations to finish. 1. Test your upgrade in a test environment first, and have a [rollback plan](plan_your_upgrade.md#rollback-plan) to reduce the risk of unplanned outages and extended downtime. -1. If available in your starting version, consider [turning on maintenance mode](../administration/maintenance_mode/index.md) +1. If available in your starting version, consider [turning on maintenance mode](../administration/maintenance_mode/_index.md) during the upgrade. 1. Consult changes for different versions of GitLab to ensure compatibility before upgrading: - [GitLab 17 changes](versions/gitlab_17_changes.md) @@ -53,7 +53,7 @@ To upgrade GitLab: 1. If your GitLab instance has any runners associated with it, upgrade them to match the current GitLab version. This step ensures [compatibility with GitLab versions](https://docs.gitlab.com/runner/#gitlab-runner-versions). 1. If you encounter problems with the upgrade, [get support](#getting-support). -1. [Disable maintenance mode](../administration/maintenance_mode/index.md#disable-maintenance-mode) if you had enabled +1. [Disable maintenance mode](../administration/maintenance_mode/_index.md#disable-maintenance-mode) if you had enabled it. 1. Unpause [running CI/CD pipelines and jobs](#cicd-pipelines-and-jobs-during-upgrades). 1. Perform [post-upgrade checks](#pre-upgrade-and-post-upgrade-checks). diff --git a/doc/update/plan_your_upgrade.md b/doc/update/plan_your_upgrade.md index 76bbed6504fa..6257b65df4f0 100644 --- a/doc/update/plan_your_upgrade.md +++ b/doc/update/plan_your_upgrade.md @@ -29,7 +29,7 @@ upgrade plan, document and share it with the answers to the following questions: to confirm that later updates are available. - Is it a single-node or a multi-node setup? If multi-node, document and share any architectural details about each node. Which external components are used? For example, Gitaly, PostgreSQL, or Redis? -- Are you using [GitLab Geo](../administration/geo/index.md)? If so, document and share any architectural details about +- Are you using [GitLab Geo](../administration/geo/_index.md)? If so, document and share any architectural details about each secondary node. - What else might be unique or interesting in your setup that might be important? - Are you running into any known issues with your current version of GitLab? diff --git a/doc/update/versions/gitlab_15_changes.md b/doc/update/versions/gitlab_15_changes.md index 8cd7415f72d4..436e75d1f5ce 100644 --- a/doc/update/versions/gitlab_15_changes.md +++ b/doc/update/versions/gitlab_15_changes.md @@ -243,7 +243,7 @@ DETAILS: ## 15.8.1 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -258,7 +258,7 @@ DETAILS: ## 15.8.0 - Git 2.38.0 and later is required by Gitaly. For self-compiled installations, you should use the [Git version provided by Gitaly](../../install/installation.md#git). -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -275,7 +275,7 @@ DETAILS: ## 15.7.6 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -289,7 +289,7 @@ DETAILS: ## 15.7.5 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -303,7 +303,7 @@ DETAILS: ## 15.7.4 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -317,7 +317,7 @@ DETAILS: ## 15.7.3 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -331,7 +331,7 @@ DETAILS: ## 15.7.2 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -346,7 +346,7 @@ DETAILS: ## 15.7.1 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -407,7 +407,7 @@ DETAILS: that secrets or sensitive information could leak if the file variable and its contents printed. For example, if they were printed in an echo output. For more information, see [Understanding the file type variable expansion change in GitLab 15.7](https://about.gitlab.com/blog/2023/02/13/impact-of-the-file-type-variable-change-15-7/). -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. - Cloning LFS objects from secondary site downloads from the primary site even when secondary is fully synced. See [the details and workaround](gitlab_16_changes.md#cloning-lfs-objects-from-secondary-site-downloads-from-the-primary-site). ### Geo installations @@ -425,7 +425,7 @@ DETAILS: ## 15.6.7 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -439,7 +439,7 @@ DETAILS: ## 15.6.6 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -464,7 +464,7 @@ DETAILS: - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. - Versions containing fix: GitLab 15.8.3 and later. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.6.4 @@ -478,7 +478,7 @@ DETAILS: - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. - Versions containing fix: GitLab 15.8.3 and later. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.6.3 @@ -492,7 +492,7 @@ DETAILS: - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. - Versions containing fix: GitLab 15.8.3 and later. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.6.2 @@ -506,7 +506,7 @@ DETAILS: - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. - Versions containing fix: GitLab 15.8.3 and later. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.6.1 @@ -520,7 +520,7 @@ DETAILS: - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. - Versions containing fix: GitLab 15.8.3 and later. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.6.0 @@ -561,16 +561,16 @@ DETAILS: - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. - Versions containing fix: GitLab 15.8.3 and later. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. - Cloning LFS objects from secondary site downloads from the primary site even when secondary is fully synced. See [the details and workaround](gitlab_16_changes.md#cloning-lfs-objects-from-secondary-site-downloads-from-the-primary-site). ## 15.5.5 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.5.4 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.5.3 @@ -582,7 +582,7 @@ DETAILS: sidekiq['routing_rules'] = [['*', 'default']] ``` -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.5.2 @@ -594,7 +594,7 @@ DETAILS: sidekiq['routing_rules'] = [['*', 'default']] ``` -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.5.1 @@ -606,7 +606,7 @@ DETAILS: sidekiq['routing_rules'] = [['*', 'default']] ``` -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.5.0 @@ -618,7 +618,7 @@ DETAILS: sidekiq['routing_rules'] = [['*', 'default']] ``` -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ### Geo installations @@ -633,19 +633,19 @@ DETAILS: ## 15.4.6 - Due to a [bug introduced in curl in GitLab 15.4.6](https://github.com/curl/curl/issues/10122), the [`no_proxy` environment variable may not work properly](../../administration/geo/replication/troubleshooting/client_http.md#secondary-site-returns-received-http-code-403-from-proxy-after-connect). Either downgrade to GitLab 15.4.5, or upgrade to GitLab 15.5.7 or a later version. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.4.5 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.4.4 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.4.3 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.4.2 @@ -655,7 +655,7 @@ DETAILS: - 15.2.5 --> 15.3.5 - 15.3.0 - 15.3.4 --> 15.3.5 - 15.4.1 --> 15.4.3 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.4.1 @@ -665,7 +665,7 @@ DETAILS: - 15.2.5 --> 15.3.5 - 15.3.0 - 15.3.4 --> 15.3.5 - 15.4.1 --> 15.4.3 -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. ## 15.4.0 @@ -691,7 +691,7 @@ DETAILS: [backfill `namespace_id` values on issues table](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91921). This migration might take multiple hours or days to complete on larger GitLab instances. Make sure the migration has completed successfully before upgrading to 15.7.0 or later. -- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. +- Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md) and [Geo replication and verification](../../administration/geo/_index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. - A redesigned sign-in page is enabled by default in GitLab 15.4 and later, with improvements shipping in later releases. For more information, see [epic 8557](https://gitlab.com/groups/gitlab-org/-/epics/8557). It can be disabled with a feature flag. Start [a Rails console](../../administration/operations/rails_console.md) and run: diff --git a/doc/update/versions/gitlab_16_changes.md b/doc/update/versions/gitlab_16_changes.md index f8ee739ff87d..0c479961ab3b 100644 --- a/doc/update/versions/gitlab_16_changes.md +++ b/doc/update/versions/gitlab_16_changes.md @@ -114,7 +114,7 @@ see [Packaged PostgreSQL deployed in an HA/Geo Cluster](https://docs.gitlab.com/ ### Geo installations -- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. +- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/_index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. See details of the problem and workaround in issue [#457159](https://gitlab.com/gitlab-org/gitlab/-/issues/457159). **Affected releases**: @@ -203,7 +203,7 @@ For more information on the changes introduced between version 2.1.0 and version ### Geo installations -- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. +- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/_index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. See details of the problem and workaround in issue [#457159](https://gitlab.com/gitlab-org/gitlab/-/issues/457159). **Affected releases**: @@ -261,7 +261,7 @@ planned for release in 16.9.1. | 16.8 | 16.8.0 - 16.8.3 | 16.8.4 | | 16.9 | 16.9.0 - 16.9.1 | 16.9.2 | -- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. +- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/_index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. See details of the problem and workaround in issue [#457159](https://gitlab.com/gitlab-org/gitlab/-/issues/457159). **Affected releases**: @@ -339,7 +339,7 @@ planned for release in 16.9.1. | 16.8 | 16.8.0 - 16.8.3 | 16.8.4 | | 16.9 | 16.9.0 - 16.9.1 | 16.9.2 | -- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. +- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/_index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. See details of the problem and workaround in issue [#457159](https://gitlab.com/gitlab-org/gitlab/-/issues/457159). **Affected releases**: @@ -429,7 +429,7 @@ Specific information applies to Linux package installations: | 16.8 | 16.8.0 - 16.8.3 | 16.8.4 | | 16.9 | 16.9.0 - 16.9.1 | 16.9.2 | -- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. +- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/_index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. See details of the problem and workaround in issue [#457159](https://gitlab.com/gitlab-org/gitlab/-/issues/457159). **Affected releases**: @@ -518,7 +518,7 @@ Specific information applies to Linux package installations: | 16.8 | 16.8.0 - 16.8.3 | 16.8.4 | | 16.9 | 16.9.0 - 16.9.1 | 16.9.2 | -- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. +- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/_index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. See details of the problem and workaround in issue [#457159](https://gitlab.com/gitlab-org/gitlab/-/issues/457159). **Affected releases**: @@ -674,7 +674,7 @@ Specific information applies to installations using Geo: | 16.8 | 16.8.0 - 16.8.3 | 16.8.4 | | 16.9 | 16.9.0 - 16.9.1 | 16.9.2 | -- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. +- Due to a bug introduced GitLab 16.5 and fixed in 17.0, [GitLab Pages](../../administration/pages/_index.md) deployment files are being orphaned on secondary Geo sites. If Pages deployments are stored locally, then this can lead to zero remaining storage and subsequently data loss in the event of a failover. See details of the problem and workaround in issue [#457159](https://gitlab.com/gitlab-org/gitlab/-/issues/457159). **Affected releases**: diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index 05c80c772ebd..8fd9d661fd80 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -233,7 +233,7 @@ The current maximum allowed value for `asciidoc_max_includes` is 64. If the valu too high, it might cause performance issues in some situations. To use includes from separate pages or external URLs, enable the `allow-uri-read` -in [application settings](../administration/wikis/index.md#allow-uri-includes-for-asciidoc). +in [application settings](../administration/wikis/_index.md#allow-uri-includes-for-asciidoc). ```plaintext // define application setting allow-uri-read to true to allow content to be read from URI diff --git a/doc/user/compliance/audit_event_streaming.md b/doc/user/compliance/audit_event_streaming.md index 7d693b6cccec..0b979cf6c01e 100644 --- a/doc/user/compliance/audit_event_streaming.md +++ b/doc/user/compliance/audit_event_streaming.md @@ -365,4 +365,4 @@ To delete AWS S3 streaming destinations to a top-level group: ## Related topics -- [Audit event streaming for instances](../../administration/audit_event_streaming/index.md) +- [Audit event streaming for instances](../../administration/audit_event_streaming/_index.md) diff --git a/doc/user/compliance/audit_event_types.md b/doc/user/compliance/audit_event_types.md index 02f9287bb106..1c26e9254c47 100644 --- a/doc/user/compliance/audit_event_types.md +++ b/doc/user/compliance/audit_event_types.md @@ -24,7 +24,7 @@ DETAILS: Audit event types are used to filter streamed audit events: -- [For instances](../../administration/audit_event_streaming/index.md#update-event-filters). +- [For instances](../../administration/audit_event_streaming/_index.md#update-event-filters). - [For top-level groups](audit_event_streaming.md#update-event-filters) Every audit event is associated with an event type. Audit event types can allow: diff --git a/doc/user/gitlab_com/_index.md b/doc/user/gitlab_com/_index.md index eeb5a2485c13..c41cc610aa30 100644 --- a/doc/user/gitlab_com/_index.md +++ b/doc/user/gitlab_com/_index.md @@ -166,7 +166,7 @@ Host gitlab.com ## GitLab Pages Some settings for [GitLab Pages](../project/pages/index.md) differ from the -[defaults for self-managed instances](../../administration/pages/index.md): +[defaults for self-managed instances](../../administration/pages/_index.md): | Setting | GitLab.com | |:--------------------------------------------------|:-----------------------| diff --git a/doc/user/gitlab_duo/setup.md b/doc/user/gitlab_duo/setup.md index 0321d217e651..db5643df26ad 100644 --- a/doc/user/gitlab_duo/setup.md +++ b/doc/user/gitlab_duo/setup.md @@ -23,7 +23,7 @@ This page focuses on how to configure a self-managed instance if you're using th - You must ensure both [outbound](#allow-outbound-connections-from-the-gitlab-instance) and [inbound](#allow-inbound-connections-from-clients-to-the-gitlab-instance) connectivity exists. Network firewalls can cause lag or delay. -- [Silent Mode](../../administration/silent_mode/index.md) must not be turned on. +- [Silent Mode](../../administration/silent_mode/_index.md) must not be turned on. - You must [activate your instance with an activation code](../../administration/license.md#activate-gitlab-ee). - GitLab Duo requires GitLab 17.2 and later for the best user experience and results. Earlier versions may continue to work, however the experience may be degraded. diff --git a/doc/user/gitlab_duo_chat/turn_on_off.md b/doc/user/gitlab_duo_chat/turn_on_off.md index 366da4a3ad39..9ae42a78784e 100644 --- a/doc/user/gitlab_duo_chat/turn_on_off.md +++ b/doc/user/gitlab_duo_chat/turn_on_off.md @@ -27,7 +27,7 @@ Prerequisites: - You must have a Premium or Ultimate subscription that is [synchronized with GitLab](https://about.gitlab.com/pricing/licensing-faq/cloud-licensing/). To make sure GitLab Duo Chat works immediately, administrators can [manually synchronize your subscription](#manually-synchronize-your-subscription). - You must have [enabled network connectivity](../gitlab_duo/setup.md). -- [Silent Mode](../../administration/silent_mode/index.md) must not be turned on. +- [Silent Mode](../../administration/silent_mode/_index.md) must not be turned on. - All of the users in your instance must have the latest version of their IDE extension. Then, depending on the version of GitLab you have, you can enable GitLab Duo Chat. diff --git a/doc/user/group/access_and_permissions.md b/doc/user/group/access_and_permissions.md index faba3f3510ca..536503784e08 100644 --- a/doc/user/group/access_and_permissions.md +++ b/doc/user/group/access_and_permissions.md @@ -283,7 +283,7 @@ To create group links with an LDAP user filter: 1. Select the **LDAP Server** for the link. 1. As the **Sync method**, select `LDAP user filter`. -1. Input your filter in the **LDAP User filter** box. Follow the [documentation on user filters](../../administration/auth/ldap/index.md#set-up-ldap-user-filter). +1. Input your filter in the **LDAP User filter** box. Follow the [documentation on user filters](../../administration/auth/ldap/_index.md#set-up-ldap-user-filter). 1. In the **LDAP Access** section, choose a [default role](../permissions.md) or [custom role](../custom_roles.md) for users synced in this group. 1. Select **Add Synchronization**. diff --git a/doc/user/markdown.md b/doc/user/markdown.md index c6c6cad3a0e0..b8a80a477d56 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -1779,7 +1779,7 @@ To customize the number of processed include directives, administrators can chan To use includes from separate wiki pages or external URLs, administrators can enable the `wiki_asciidoc_allow_uri_includes` -[application setting](../administration/wikis/index.md#allow-uri-includes-for-asciidoc). +[application setting](../administration/wikis/_index.md#allow-uri-includes-for-asciidoc). ```markdown <!-- define application setting wiki_asciidoc_allow_uri_includes to true to allow content to be read from URI --> diff --git a/doc/user/packages/package_registry/dependency_proxy/index.md b/doc/user/packages/package_registry/dependency_proxy/index.md index fe7f8674acc7..23ac3ec5d1a6 100644 --- a/doc/user/packages/package_registry/dependency_proxy/index.md +++ b/doc/user/packages/package_registry/dependency_proxy/index.md @@ -30,7 +30,7 @@ To use the dependency proxy for packages, ensure your project is configured prop and that users who pull from the cache have the necessary authentication: 1. In the global configuration, if the following features are disabled, enable them: - - The [`package` feature](../../../../administration/packages/index.md#enable-or-disable-the-package-registry). Enabled by default. + - The [`package` feature](../../../../administration/packages/_index.md#enable-or-disable-the-package-registry). Enabled by default. - The [`dependency_proxy` feature](../../../../administration/packages/dependency_proxy.md#turn-on-the-dependency-proxy). Enabled by default. 1. In the project settings, if the [`package` feature](../index.md#disable-the-package-registry) is disabled, enable it. It is enabled by default. diff --git a/doc/user/packages/package_registry/index.md b/doc/user/packages/package_registry/index.md index d8be4e1d0c01..39ad2cb53139 100644 --- a/doc/user/packages/package_registry/index.md +++ b/doc/user/packages/package_registry/index.md @@ -113,7 +113,7 @@ The package registry is automatically enabled. If you are using a self-managed instance of GitLab, your administrator can remove the menu item, **Packages and registries**, from the GitLab sidebar. For more information, -see the [administration documentation](../../../administration/packages/index.md). +see the [administration documentation](../../../administration/packages/_index.md). You can also remove the package registry for your project specifically: diff --git a/doc/user/packages/terraform_module_registry/index.md b/doc/user/packages/terraform_module_registry/index.md index 82c1664ab009..aac44d37607a 100644 --- a/doc/user/packages/terraform_module_registry/index.md +++ b/doc/user/packages/terraform_module_registry/index.md @@ -298,7 +298,7 @@ The package is permanently deleted. The Terraform Module Registry is automatically enabled. For self-managed instances, a GitLab administrator can -[disable](../../../administration/packages/index.md) **Packages and registries**, +[disable](../../../administration/packages/_index.md) **Packages and registries**, which removes this menu item from the sidebar. You can also remove the Terraform Module Registry for a specific project: diff --git a/doc/user/profile/account/create_accounts.md b/doc/user/profile/account/create_accounts.md index 490da2f7a0ae..06ae727c9ed6 100644 --- a/doc/user/profile/account/create_accounts.md +++ b/doc/user/profile/account/create_accounts.md @@ -63,7 +63,7 @@ GitLab can automatically create user accounts through authentication integration Users are created when they: - Sign in for the first time with: - - [LDAP](../../../administration/auth/ldap/index.md) + - [LDAP](../../../administration/auth/ldap/_index.md) - [Group SAML](../../group/saml_sso/index.md) - An [OmniAuth provider](../../../integration/omniauth.md) that has the setting `allow_single_sign_on` turned on - Are provisioned through [SCIM](../../group/saml_sso/scim_setup.md) in the identity provider. diff --git a/doc/user/profile/account/two_factor_authentication_troubleshooting.md b/doc/user/profile/account/two_factor_authentication_troubleshooting.md index fdc811b878d8..bab3d2bbac69 100644 --- a/doc/user/profile/account/two_factor_authentication_troubleshooting.md +++ b/doc/user/profile/account/two_factor_authentication_troubleshooting.md @@ -37,7 +37,7 @@ Instead you can authenticate: with `read_registry` or `write_registry` scope is required. - For [dependency proxy](../../packages/dependency_proxy/index.md#authenticate-with-the-dependency-proxy-for-container-images) requests, a PAT with `read_registry` and `write_registry` scopes is required. -- If you have configured LDAP, using an [LDAP password](../../../administration/auth/ldap/index.md) +- If you have configured LDAP, using an [LDAP password](../../../administration/auth/ldap/_index.md) - Using an [OAuth credential helper](../../profile/account/two_factor_authentication.md#oauth-credential-helpers). ## Error: "invalid pin code" diff --git a/doc/user/project/integrations/webhooks_troubleshooting.md b/doc/user/project/integrations/webhooks_troubleshooting.md index d0270e425b21..78adcd7da8cf 100644 --- a/doc/user/project/integrations/webhooks_troubleshooting.md +++ b/doc/user/project/integrations/webhooks_troubleshooting.md @@ -119,6 +119,6 @@ To resolve this issue: If a webhook is not triggered, verify that: - The webhook is not [disabled automatically](webhooks.md#auto-disabled-webhooks). -- The GitLab instance is not in [Silent Mode](../../../administration/silent_mode/index.md). +- The GitLab instance is not in [Silent Mode](../../../administration/silent_mode/_index.md). - The **Push event activities limit** and **Push event hooks limit** settings in the [**Admin** area](../../../administration/settings/push_event_activities_limit.md) are set to a value greater than `0`. diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md index a1f6bf6ac037..eb9d59e97f85 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md @@ -31,7 +31,7 @@ To set up Pages with a custom domain name, read the requirements and steps below ### Prerequisites -- An administrator has configured the server for [GitLab Pages custom domains](../../../../administration/pages/index.md#advanced-configuration) +- An administrator has configured the server for [GitLab Pages custom domains](../../../../administration/pages/_index.md#advanced-configuration) - A GitLab Pages website up and running, served under the default Pages domain (`*.gitlab.io`, for GitLab.com). - A custom domain name `example.com` or subdomain `subdomain.example.com`. @@ -73,7 +73,7 @@ according to the type of domain you want to use with your Pages site: - [For subdomains](#for-subdomains), `subdomain.example.com`. - [For both](#for-both-root-and-subdomains). -You can [configure IPv6 on self-managed instances](../../../../administration/pages/index.md#advanced-configuration), +You can [configure IPv6 on self-managed instances](../../../../administration/pages/_index.md#advanced-configuration), but IPv6 is not currently configured for Pages on GitLab.com. Follow [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/214718) for details. @@ -177,7 +177,7 @@ Additionally: - Domain verification is **required for GitLab.com users**. For GitLab Self-Managed, your GitLab administrator has the option - to [disabled custom domain verification](../../../../administration/pages/index.md#custom-domain-verification). + to [disabled custom domain verification](../../../../administration/pages/_index.md#custom-domain-verification). - [DNS propagation may take some time (up to 24 hours)](https://www.inmotionhosting.com/support/domain-names/dns-nameserver-changes/complete-guide-to-dns-records/), although it's usually a matter of minutes to complete. Until it does, verification fails, and attempts to visit your domain result in a 404. diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md index 30f6b2ac45bd..1b68b3c89f32 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md @@ -20,7 +20,7 @@ open source Certificate Authority. WARNING: This feature covers only certificates for **custom domains**, not the wildcard certificate required to run -[Pages daemon](../../../../administration/pages/index.md) (Self-managed, Free, Premium, and Ultimate only). Wildcard +[Pages daemon](../../../../administration/pages/_index.md) (Self-managed, Free, Premium, and Ultimate only). Wildcard certificate generation is tracked in [this issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3342). ## Prerequisites @@ -38,7 +38,7 @@ Before you can enable automatic provisioning of an SSL certificate for your doma The GitLab integration with Let's Encrypt is enabled and available on GitLab.com. For **self-managed** GitLab instances, make sure your administrator has -[enabled it](../../../../administration/pages/index.md#lets-encrypt-integration). +[enabled it](../../../../administration/pages/_index.md#lets-encrypt-integration). ## Enabling Let's Encrypt integration for your custom domain diff --git a/doc/user/project/pages/index.md b/doc/user/project/pages/index.md index 6fec3439cd9b..31a782b174a8 100644 --- a/doc/user/project/pages/index.md +++ b/doc/user/project/pages/index.md @@ -101,7 +101,7 @@ If you're using GitLab.com, your website is publicly available to the internet. To restrict access to your website, enable [GitLab Pages Access Control](pages_access_control.md). If you're using a self-managed instance, your websites are published on your -own server, according to the [Pages settings](../../../administration/pages/index.md) +own server, according to the [Pages settings](../../../administration/pages/_index.md) chosen by your sysadmin, who can make them public or internal. ## Pages examples @@ -118,7 +118,7 @@ and adapt for your own needs: ## Administer GitLab Pages for self-managed instances If you are running a self-managed instance of GitLab, -[follow the administration steps](../../../administration/pages/index.md) to configure Pages. +[follow the administration steps](../../../administration/pages/_index.md) to configure Pages. <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> Watch a [video tutorial](https://www.youtube.com/watch?v=dD8c7WNcc6s) about how to get started with GitLab Pages administration. @@ -311,7 +311,7 @@ delete older deployments, see By default, parallel deployments expire after 24 hours, after which they are deleted. If you're using a self-hosted instance, your instance admin can -[configure a different default duration](../../../administration/pages/index.md#configure-the-default-expiry-for-parallel-deployments). +[configure a different default duration](../../../administration/pages/_index.md#configure-the-default-expiry-for-parallel-deployments). To customize the expiry time, [configure `pages.expire_in`](#expiring-deployments). diff --git a/doc/user/project/pages/introduction.md b/doc/user/project/pages/introduction.md index 3983906fb3b6..b6bd8a8b56b0 100644 --- a/doc/user/project/pages/introduction.md +++ b/doc/user/project/pages/introduction.md @@ -17,7 +17,7 @@ To familiarize yourself with GitLab Pages first: - Read an [introduction to GitLab Pages](index.md). - Learn [how to get started with Pages](index.md#getting-started). - Learn how to enable GitLab Pages - across your GitLab instance on the [administrator documentation](../../../administration/pages/index.md). + across your GitLab instance on the [administrator documentation](../../../administration/pages/_index.md). ## GitLab Pages requirements diff --git a/doc/user/project/pages/pages_access_control.md b/doc/user/project/pages/pages_access_control.md index c416b169179f..60095ba9a805 100644 --- a/doc/user/project/pages/pages_access_control.md +++ b/doc/user/project/pages/pages_access_control.md @@ -10,7 +10,7 @@ DETAILS: **Offering:** GitLab.com, GitLab Self-Managed, GitLab Dedicated You can enable Pages access control on your project -if your administrator has [enabled the access control feature](../../../administration/pages/index.md#access-control) +if your administrator has [enabled the access control feature](../../../administration/pages/_index.md#access-control) on your GitLab instance. When enabled, only authenticated [members of your project](../../permissions.md#project-members-permissions) (at least Guest) can access your website, by default: @@ -22,7 +22,7 @@ For a demonstration, see [Pages access controls](https://www.youtube.com/watch?v 1. Select **Settings > General**. 1. Expand **Visibility, project features, permissions**. 1. Toggle the **Pages** button to enable the access control. If you don't see the toggle button, - that means it isn't enabled. Ask your administrator to [enable it](../../../administration/pages/index.md#access-control). + that means it isn't enabled. Ask your administrator to [enable it](../../../administration/pages/_index.md#access-control). 1. The Pages access control dropdown list allows you to set who can view pages hosted with GitLab Pages, depending on your project's visibility: @@ -55,7 +55,7 @@ When enabled, all projects in the group and its subgroups become visible only to Prerequisites -- Public access to Pages must not be [disabled at the instance level.](../../../administration/pages/index.md#disable-public-access-to-all-pages-sites) +- Public access to Pages must not be [disabled at the instance level.](../../../administration/pages/_index.md#disable-public-access-to-all-pages-sites) - You must have the Owner role for the group. To do this: diff --git a/doc/user/project/repository/mirror/index.md b/doc/user/project/repository/mirror/index.md index c59980d18822..2f6d2f7fa46d 100644 --- a/doc/user/project/repository/mirror/index.md +++ b/doc/user/project/repository/mirror/index.md @@ -127,7 +127,7 @@ You can also manually trigger an update: set by the administrator on self-managed instances. NOTE: -[GitLab Silent Mode](../../../../administration/silent_mode/index.md) disables both push and pull updates. +[GitLab Silent Mode](../../../../administration/silent_mode/_index.md) disables both push and pull updates. ### Force an update diff --git a/doc/user/project/repository/mirror/pull.md b/doc/user/project/repository/mirror/pull.md index 9904213e96eb..5781b42df37d 100644 --- a/doc/user/project/repository/mirror/pull.md +++ b/doc/user/project/repository/mirror/pull.md @@ -66,7 +66,7 @@ Prerequisites: create a [personal access token for GitHub](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with the `repo` scope. If 2FA is enabled, this personal access token serves as your GitHub password. -- [GitLab Silent Mode](../../../../administration/silent_mode/index.md) is not enabled. +- [GitLab Silent Mode](../../../../administration/silent_mode/_index.md) is not enabled. 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > Repository**. diff --git a/doc/user/project/repository/mirror/push.md b/doc/user/project/repository/mirror/push.md index d0a12e0dfa77..24966e5e8eeb 100644 --- a/doc/user/project/repository/mirror/push.md +++ b/doc/user/project/repository/mirror/push.md @@ -32,7 +32,7 @@ it is deleted from the remote mirror on the next push. Branches with unmerged changes are kept. If a branch diverges, the **Mirroring repositories** section displays an error. -[GitLab Silent Mode](../../../../administration/silent_mode/index.md) disables pushing to, +[GitLab Silent Mode](../../../../administration/silent_mode/_index.md) disables pushing to, and pulling from, remote mirrors. ## Configure push mirroring diff --git a/doc/user/project/repository/mirror/troubleshooting.md b/doc/user/project/repository/mirror/troubleshooting.md index e488778e387f..f82a1b08796a 100644 --- a/doc/user/project/repository/mirror/troubleshooting.md +++ b/doc/user/project/repository/mirror/troubleshooting.md @@ -234,7 +234,7 @@ The error can be avoided by: ## Pull or push mirror fails to update: `The project is not mirrored` -Pull and push mirrors fail to update when [GitLab Silent Mode](../../../../administration/silent_mode/index.md) is enabled. +Pull and push mirrors fail to update when [GitLab Silent Mode](../../../../administration/silent_mode/_index.md) is enabled. When this happens, the option to allow mirroring on the UI is disabled. An administrator can check to confirm that GitLab Silent Mode is disabled. diff --git a/doc/user/project/use_project_as_go_package.md b/doc/user/project/use_project_as_go_package.md index da5c5129940e..8df56c5b3ebe 100644 --- a/doc/user/project/use_project_as_go_package.md +++ b/doc/user/project/use_project_as_go_package.md @@ -134,7 +134,7 @@ For example, `GOPRIVATE=gitlab.com/namespace/* go mod tidy`. ## Fetch Go modules from Geo secondary sites -Use [Geo](../../administration/geo/index.md) to access Git repositories that contain Go modules +Use [Geo](../../administration/geo/_index.md) to access Git repositories that contain Go modules on secondary Geo servers. You can use SSH or HTTP to access the Geo secondary server. diff --git a/doc/user/project/wiki/group.md b/doc/user/project/wiki/group.md index d96f88e5fdae..609b004b3e40 100644 --- a/doc/user/project/wiki/group.md +++ b/doc/user/project/wiki/group.md @@ -76,7 +76,7 @@ To open group settings: ## Related topics -- [Wiki settings for administrators](../../../administration/wikis/index.md) +- [Wiki settings for administrators](../../../administration/wikis/_index.md) - [Project wikis API](../../../api/wikis.md) - [Group repository storage moves API](../../../api/group_repository_storage_moves.md) - [Group wikis API](../../../api/group_wikis.md) diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md index fe5dd9047af2..392e7d26112a 100644 --- a/doc/user/project/wiki/index.md +++ b/doc/user/project/wiki/index.md @@ -346,7 +346,7 @@ can enable or disable a project wiki by following the instructions in [Sharing and permissions](../settings/index.md#configure-project-features-and-permissions). Administrators for GitLab Self-Managed can -[configure additional wiki settings](../../../administration/wikis/index.md). +[configure additional wiki settings](../../../administration/wikis/_index.md). You can disable group wikis from the [group settings](group.md#configure-group-wiki-visibility) @@ -486,7 +486,7 @@ All data from the wiki has been cleared, and the wiki is ready for use. ## Related topics -- [Wiki settings for administrators](../../../administration/wikis/index.md) +- [Wiki settings for administrators](../../../administration/wikis/_index.md) - [Project wikis API](../../../api/wikis.md) - [Group wikis API](../../../api/group_wikis.md) - [Group repository storage moves API](../../../api/group_repository_storage_moves.md) diff --git a/doc/user/project/working_with_projects.md b/doc/user/project/working_with_projects.md index 94b9ff579187..5dae6ae400e0 100644 --- a/doc/user/project/working_with_projects.md +++ b/doc/user/project/working_with_projects.md @@ -526,7 +526,7 @@ You cannot use LDAP groups to manage project access, but you can use the followi Prerequisites: -- You must [integrate LDAP with GitLab](../../administration/auth/ldap/index.md). +- You must [integrate LDAP with GitLab](../../administration/auth/ldap/_index.md). - You must be an administrator. 1. [Create a group](../group/index.md#create-a-group) to track membership of your project. diff --git a/ee/app/assets/javascripts/audit_events/constants.js b/ee/app/assets/javascripts/audit_events/constants.js index 29b5b66d6dae..e600189fe712 100644 --- a/ee/app/assets/javascripts/audit_events/constants.js +++ b/ee/app/assets/javascripts/audit_events/constants.js @@ -84,7 +84,7 @@ export const STREAM_ITEMS_I18N = { FILTER_TOOLTIP_LABEL: s__( 'AuditStreams|Destination has filters applied. %{linkStart}What are filters?%{linkEnd}', ), - FILTER_TOOLTIP_ADMIN_LINK: helpPagePath('administration/audit_event_streaming/index', { + FILTER_TOOLTIP_ADMIN_LINK: helpPagePath('administration/audit_event_streaming/_index', { anchor: 'update-event-filters', }), FILTER_TOOLTIP_GROUP_LINK: helpPagePath('user/compliance/audit_event_streaming', { diff --git a/ee/app/assets/javascripts/geo_replicable/constants.js b/ee/app/assets/javascripts/geo_replicable/constants.js index 4ee3a530e059..65fc62804e86 100644 --- a/ee/app/assets/javascripts/geo_replicable/constants.js +++ b/ee/app/assets/javascripts/geo_replicable/constants.js @@ -62,5 +62,5 @@ export const DEFAULT_PAGE_SIZE = 20; export const GEO_BULK_ACTION_MODAL_ID = 'geo-bulk-action'; export const GEO_TROUBLESHOOTING_LINK = helpPagePath( - 'administration/geo/replication/troubleshooting.md', + 'administration/geo/replication/troubleshooting/_index.md', ); diff --git a/ee/app/assets/javascripts/geo_sites/constants.js b/ee/app/assets/javascripts/geo_sites/constants.js index 25b733ca588b..f741bc8f2775 100644 --- a/ee/app/assets/javascripts/geo_sites/constants.js +++ b/ee/app/assets/javascripts/geo_sites/constants.js @@ -1,7 +1,7 @@ import { helpPagePath } from '~/helpers/help_page_helper'; import { __, s__ } from '~/locale'; -export const GEO_INFO_URL = helpPagePath('administration/geo/index.md'); +export const GEO_INFO_URL = helpPagePath('administration/geo/_index.md'); export const HELP_SITE_HEALTH_URL = helpPagePath( 'administration/geo/replication/troubleshooting/common.html', @@ -9,7 +9,7 @@ export const HELP_SITE_HEALTH_URL = helpPagePath( ); export const GEO_TROUBLESHOOTING_URL = helpPagePath( - 'administration/geo/replication/troubleshooting.html', + 'administration/geo/replication/troubleshooting/_index.md', ); export const HELP_INFO_URL = helpPagePath( @@ -17,7 +17,7 @@ export const HELP_INFO_URL = helpPagePath( { anchor: 'repository-verification' }, ); -export const REPLICATION_PAUSE_URL = helpPagePath('administration/geo/index.html', { +export const REPLICATION_PAUSE_URL = helpPagePath('administration/geo/_index.html', { anchor: 'pausing-and-resuming-replication', }); diff --git a/ee/app/views/admin/application_settings/_ldap_access_setting.html.haml b/ee/app/views/admin/application_settings/_ldap_access_setting.html.haml index 0897a32c86ed..6aaed7fc7dfa 100644 --- a/ee/app/views/admin/application_settings/_ldap_access_setting.html.haml +++ b/ee/app/views/admin/application_settings/_ldap_access_setting.html.haml @@ -12,7 +12,7 @@ help_text: '%{help_text} %{help_link}'.html_safe % { help_text: help_text_lock, help_link: help_link_lock } - help_text_group = _('If checked, group owners can manage LDAP group links and LDAP member overrides') - - help_link_group = link_to sprite_icon('question-o'), help_page_path('administration/auth/ldap/index.md') + - help_link_group = link_to sprite_icon('question-o'), help_page_path('administration/auth/ldap/_index.md') = form.gitlab_ui_checkbox_component :allow_group_owners_to_manage_ldap, _('Allow group owners to manage LDAP-related settings'), help_text: '%{help_text} %{help_link}'.html_safe % { help_text: help_text_group, help_link: help_link_group } diff --git a/ee/app/views/admin/application_settings/_maintenance_mode_settings_form.html.haml b/ee/app/views/admin/application_settings/_maintenance_mode_settings_form.html.haml index ea9fcd6a7ffc..56be0a234e99 100644 --- a/ee/app/views/admin/application_settings/_maintenance_mode_settings_form.html.haml +++ b/ee/app/views/admin/application_settings/_maintenance_mode_settings_form.html.haml @@ -5,7 +5,7 @@ expanded: expanded_by_default?) do |c| - c.with_description do = _('Prevent users from performing write operations while GitLab maintenance is in progress.') - = link_to _('Learn more.'), help_page_path('administration/maintenance_mode/index.md'), target: '_blank', rel: 'noopener noreferrer' + = link_to _('Learn more.'), help_page_path('administration/maintenance_mode/_index.md'), target: '_blank', rel: 'noopener noreferrer' - c.with_body do #js-maintenance-mode-settings{ data: { "maintenance-enabled" => @application_setting.maintenance_mode.to_s, "banner-message" => @application_setting.maintenance_mode_message } } diff --git a/ee/app/views/groups/group_members/_ldap_sync.html.haml b/ee/app/views/groups/group_members/_ldap_sync.html.haml index 611df532180e..b50123321481 100644 --- a/ee/app/views/groups/group_members/_ldap_sync.html.haml +++ b/ee/app/views/groups/group_members/_ldap_sync.html.haml @@ -3,7 +3,7 @@ alert_options: { class: 'gl-mt-5 gl-mb-5' }) do |c| - c.with_body do The members of this group are - = link_to('managed with LDAP', help_page_path('administration/auth/ldap/index.md'), target: '_blank', rel: 'noopener noreferrer') + '.' + = link_to('managed with LDAP', help_page_path('administration/auth/ldap/_index.md'), target: '_blank', rel: 'noopener noreferrer') + '.' You cannot add or remove members directly from the member list. Instead, you must use = link_to('LDAP sync', help_page_path('administration/auth/ldap/ldap_synchronization.md'), target: '_blank', rel: 'noopener noreferrer') diff --git a/ee/app/views/shared/empty_states/_geo_replication.html.haml b/ee/app/views/shared/empty_states/_geo_replication.html.haml index 0f08299b98bf..ee327d62375e 100644 --- a/ee/app/views/shared/empty_states/_geo_replication.html.haml +++ b/ee/app/views/shared/empty_states/_geo_replication.html.haml @@ -1,4 +1,4 @@ -- geo_troubleshooting_link = help_page_path('administration/geo/replication/troubleshooting/index.md') +- geo_troubleshooting_link = help_page_path('administration/geo/replication/troubleshooting/_index.md') - image = 'illustrations/empty-state/empty-geo-md.svg' - title = has_filters ? _('No results found') : s_('Geo|There are no %{replicable_type} to show') % { replicable_type: replicable_type } - geo_troubleshooting_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: geo_troubleshooting_link } diff --git a/ee/app/views/shared/groups/_max_pages_size_setting.html.haml b/ee/app/views/shared/groups/_max_pages_size_setting.html.haml index 6a5c59e5b46f..e1674214cb81 100644 --- a/ee/app/views/shared/groups/_max_pages_size_setting.html.haml +++ b/ee/app/views/shared/groups/_max_pages_size_setting.html.haml @@ -5,7 +5,7 @@ id: 'js-pages-settings', expanded: expanded) do |c| - c.with_description do - - pages_link_url = help_page_path('administration/pages/index.md', anchor: 'set-maximum-size-of-each-gitlab-pages-site-in-a-group') + - pages_link_url = help_page_path('administration/pages/_index.md', anchor: 'set-maximum-size-of-each-gitlab-pages-site-in-a-group') - pages_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: pages_link_url } = s_('GroupSettings|Set a size limit for all content in each Pages site in this group. %{link_start}Learn more.%{link_end}').html_safe % { link_start: pages_link_start, link_end: '</a>'.html_safe } - c.with_body do diff --git a/tooling/audit_events/docs/templates/audit_event_types.md.erb b/tooling/audit_events/docs/templates/audit_event_types.md.erb index 2f28a2343231..cec40e6a96ef 100644 --- a/tooling/audit_events/docs/templates/audit_event_types.md.erb +++ b/tooling/audit_events/docs/templates/audit_event_types.md.erb @@ -42,7 +42,7 @@ DETAILS: Audit event types are used to filter streamed audit events: -- [For instances](../../administration/audit_event_streaming/index.md#update-event-filters). +- [For instances](../../administration/audit_event_streaming/_index.md#update-event-filters). - [For top-level groups](audit_event_streaming.md#update-event-filters) Every audit event is associated with an event type. Audit event types can allow: -- GitLab