Merge branch 'update-links-for-documentation' into 'master'

Replace `.html` with `.md` in `help_page_link` helpers

See merge request gitlab-org/gitlab!35864

app/helpers/ide_helper.rb

@@ -9,7 +9,7 @@ module IdeHelper
       "pipelines-empty-state-svg-path": image_path('illustrations/pipelines_empty.svg'),
       "promotion-svg-path": image_path('illustrations/web-ide_promotion.svg'),
       "ci-help-page-path" => help_page_path('ci/quick_start/README'),
-      "web-ide-help-page-path" => help_page_path('user/project/web_ide/index.html'),
+      "web-ide-help-page-path" => help_page_path('user/project/web_ide/index.md'),
       "clientside-preview-enabled": Gitlab::CurrentSettings.web_ide_clientside_preview_enabled?.to_s,
       "render-whitespace-in-code": current_user.render_whitespace_in_code.to_s,
       "codesandbox-bundler-url": Gitlab::CurrentSettings.web_ide_clientside_preview_bundler_url

app/helpers/jobs_helper.rb

@@ -5,8 +5,8 @@ module JobsHelper
     {
       "endpoint" => project_job_path(@project, @build, format: :json),
       "project_path" => @project.full_path,
-      "deployment_help_url" => help_page_path('user/project/clusters/index.html', anchor: 'troubleshooting-failed-deployment-jobs'),
-      "runner_help_url" => help_page_path('ci/runners/README.html', anchor: 'setting-maximum-job-timeout-for-a-runner'),
+      "deployment_help_url" => help_page_path('user/project/clusters/index.md', anchor: 'troubleshooting-failed-deployment-jobs'),
+      "runner_help_url" => help_page_path('ci/runners/README.md', anchor: 'setting-maximum-job-timeout-for-a-runner'),
       "runner_settings_url" => project_runners_path(@build.project, anchor: 'js-runners-settings'),
       "variables_settings_url" => project_variables_path(@build.project, anchor: 'js-cicd-variables-settings'),
       "page_path" => project_job_path(@project, @build),

app/helpers/operations_helper.rb

@@ -27,7 +27,7 @@ module OperationsHelper
       'authorization_key' => alerts_service.token,
       'prometheus_url' => notify_project_prometheus_alerts_url(@project, format: :json),
       'url' => alerts_service.url,
-      'alerts_setup_url' => help_page_path('user/project/integrations/generic_alerts.html', anchor: 'setting-up-generic-alerts'),
+      'alerts_setup_url' => help_page_path('user/project/integrations/generic_alerts.md', anchor: 'setting-up-generic-alerts'),
       'alerts_usage_url' => project_alert_management_index_path(@project)
     }
   end

app/views/admin/application_settings/_email.html.haml

@@ -20,7 +20,7 @@
       = f.label :commit_email_hostname, _('Custom hostname (for private commit emails)'), class: 'label-bold'
       = f.text_field :commit_email_hostname, class: 'form-control'
       .form-text.text-muted
-        - commit_email_hostname_docs_link = link_to _('Learn more'), help_page_path('user/admin_area/settings/email', anchor: 'custom-private-commit-email-hostname'), target: '_blank'
+        - commit_email_hostname_docs_link = link_to _('Learn more'), help_page_path('user/admin_area/settings/email.md', anchor: 'custom-hostname-for-private-commit-emails'), target: '_blank'
         = _("This setting will update the hostname that is used to generate private commit emails. %{learn_more}").html_safe % { learn_more: commit_email_hostname_docs_link }
 
     = render_if_exists 'admin/application_settings/email_additional_text_setting', form: f

app/views/clusters/clusters/show.html.haml

@@ -32,7 +32,7 @@
   ingress_mod_security_help_path: help_page_path('user/clusters/applications.md', anchor: 'web-application-firewall-modsecurity'),
   environments_help_path: help_page_path('ci/environments/index.md', anchor: 'defining-environments'),
   clusters_help_path: help_page_path('user/project/clusters/index.md', anchor: 'deploying-to-a-kubernetes-cluster'),
-  deploy_boards_help_path: help_page_path('user/project/deploy_boards.html', anchor: 'enabling-deploy-boards'),
+  deploy_boards_help_path: help_page_path('user/project/deploy_boards.md', anchor: 'enabling-deploy-boards'),
   cloud_run_help_path: help_page_path('user/project/clusters/add_remove_clusters.md', anchor: 'cloud-run-for-anthos'),
   manage_prometheus_path: manage_prometheus_path,
   cluster_id: @cluster.id } }

app/views/projects/default_branch/_show.html.haml

@@ -26,6 +26,6 @@
               %strong= _("Auto-close referenced issues on default branch")
             .form-text.text-muted
               = _("Issues referenced by merge requests and commits within the default branch will be closed automatically")
-              = link_to icon('question-circle'), help_page_path('user/project/issues/managing_issues.html', anchor: 'disabling-automatic-issue-closing'), target: '_blank'
+              = link_to icon('question-circle'), help_page_path('user/project/issues/managing_issues.md', anchor: 'disabling-automatic-issue-closing'), target: '_blank'
 
       = f.submit 'Save changes', class: "btn btn-success"

app/views/projects/merge_requests/_widget.html.haml

@@ -9,7 +9,7 @@
     window.gl.mrWidgetData.squash_before_merge_help_path = '#{help_page_path("user/project/merge_requests/squash_and_merge")}';
     window.gl.mrWidgetData.troubleshooting_docs_path = '#{help_page_path('user/project/merge_requests/reviewing_and_managing_merge_requests.md', anchor: 'troubleshooting')}';
     window.gl.mrWidgetData.pipeline_must_succeed_docs_path = '#{help_page_path('user/project/merge_requests/merge_when_pipeline_succeeds.md', anchor: 'only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds')}';
-    window.gl.mrWidgetData.security_approvals_help_page_path = '#{help_page_path('user/application_security/index.html', anchor: 'security-approvals-in-merge-requests-ultimate')}';
+    window.gl.mrWidgetData.security_approvals_help_page_path = '#{help_page_path('user/application_security/index.md', anchor: 'security-approvals-in-merge-requests-ultimate')}';
     window.gl.mrWidgetData.eligible_approvers_docs_path = '#{help_page_path('user/project/merge_requests/merge_request_approvals', anchor: 'eligible-approvers')}';
     window.gl.mrWidgetData.pipelines_empty_svg_path = '#{image_path('illustrations/pipelines_empty.svg')}';
 

app/views/projects/new.html.haml

@@ -16,7 +16,7 @@
       %h4.gl-mt-0
         = _('New project')
       %p
-        - among_other_things_link = link_to _('among other things'), help_page_path("user/project/index.md", anchor: "projects-features"), target: '_blank'
+        - among_other_things_link = link_to _('among other things'), help_page_path("user/project/index.md", anchor: "project-features"), target: '_blank'
         = _('A project is where you house your files (repository), plan your work (issues), and publish your documentation (wiki), %{among_other_things_link}.').html_safe % { among_other_things_link: among_other_things_link }
       %p
         = _('All features are enabled for blank projects, from templates, or when importing, but you can disable them afterward in the project settings.')

app/views/projects/services/alerts/_help.html.haml

@@ -3,5 +3,5 @@
   authorization_key: @service.token,
   url: @service.url || _('<namespace / project>'),
   disabled: 'true',
-  alerts_setup_url: help_page_path('user/project/integrations/generic_alerts.html', anchor: 'setting-up-generic-alerts'),
-  alerts_usage_url: help_page_path('user/project/operations/alert_management.html') } }
+  alerts_setup_url: help_page_path('user/project/integrations/generic_alerts.md', anchor: 'setting-up-generic-alerts'),
+  alerts_usage_url: help_page_path('user/project/operations/alert_management.md') } }

ee/app/views/admin/application_settings/_ldap_access_setting.html.haml

@@ -11,7 +11,7 @@
       = _('Lock memberships to LDAP synchronization')
   %span.form-text.text-muted
     = _('If checked, new group memberships and permissions can only be added via LDAP synchronization')
-    = link_to icon('question-circle'), help_page_path('administration/auth/index.md', anchor: 'global-group-memberships-lock-starter-only')
+    = link_to icon('question-circle'), help_page_path('administration/auth/ldap/index.md', anchor: 'global-group-memberships-lock-starter-only')
 
   .form-check
     = form.check_box :allow_group_owners_to_manage_ldap, class: 'form-check-input'

ee/app/views/admin/geo/designs/index.html.haml

 = render 'admin/geo/shared/replication_nav'
 #js-geo-replicable{ data: { "geo-replicable-empty-svg-path" => image_path('illustrations/empty-state/geo-replication-empty.svg'),
-  "geo-troubleshooting-link" => help_page_path('administration/geo/replication/troubleshooting.html'),
+  "geo-troubleshooting-link" => help_page_path('administration/geo/replication/troubleshooting.md'),
   "replicable-type" => 'designs' } }

ee/app/views/admin/geo/package_files/index.html.haml

 = render "admin/geo/shared/replication_nav"
 - if Feature.enabled?(:geo_self_service_framework)
   #js-geo-replicable{ data: { "geo-replicable-empty-svg-path" => image_path("illustrations/empty-state/geo-replication-empty.svg"),
-    "geo-troubleshooting-link" => help_page_path("administration/geo/replication/troubleshooting.html"),
+    "geo-troubleshooting-link" => help_page_path("administration/geo/replication/troubleshooting.md"),
     "replicable-type" => "package_files",
     "graphql" => "true" } }

ee/app/views/groups/settings/_ip_restriction.html.haml

@@ -5,5 +5,5 @@
 .form-group
   = f.text_field :ip_restriction_ranges, class: 'form-control', data: { qa_selector: 'ip_restriction_field' }, placeholder: _('Enter IP address range')
   .form-text.text-muted
-    - read_more_link = link_to(_('Read more'), help_page_path('user/group/index', anchor: 'ip-access-restriction-ultimate'))
+    - read_more_link = link_to(_('Read more'), help_page_path('user/group/index.md', anchor: 'ip-access-restriction-premium'))
     = _('This group, including all subgroups, projects and git repositories, will only be reachable from the specified IP address range. Multiple addresses are supported with comma delimiters.<br>Example: <code>192.168.0.0/24,192.168.1.0/24</code>. %{read_more_link}.').html_safe % { read_more_link: read_more_link }

ee/app/views/namespaces/pipelines_quota/_list.haml

@@ -51,7 +51,7 @@
       %tr
         %td{ colspan: 2 }
           .nothing-here-block
-            - runners_doc_path = help_page_path('ci/runners/README.html')
+            - runners_doc_path = help_page_path('ci/runners/README.md')
             - help_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: runners_doc_path }
             = s_('UsageQuota|%{help_link_start}Shared runners%{help_link_end} are disabled, so there are no limits set on pipeline usage').html_safe % { help_link_start: help_link_start, help_link_end: '</a>'.html_safe }
     - else

ee/app/views/projects/_merge_request_approvals_settings_form.html.haml

@@ -13,7 +13,7 @@
     'rules_path': expose_path(api_v4_projects_approval_settings_rules_path(id: @project.id)),
     'allow_multi_rule': @project.multiple_approval_rules_available?.to_s,
     'eligible_approvers_docs_path': help_page_path('user/project/merge_requests/merge_request_approvals', anchor: 'eligible-approvers'),
-    'security_approvals_help_page_path': help_page_path('user/application_security/index.html', anchor: 'security-approvals-in-merge-requests-ultimate')} }
+    'security_approvals_help_page_path': help_page_path('user/application_security/index.md', anchor: 'security-approvals-in-merge-requests-ultimate')} }
     .text-center.gl-mt-3
       = sprite_icon('spinner', size: 24, css_class: 'gl-spinner')
 

ee/app/views/projects/settings/ci_cd/_pipeline_subscriptions.html.haml

@@ -9,7 +9,7 @@
     %p
       = _("Set up pipeline subscriptions for this project.")
     %p
-      - default_branch_docs = link_to(_("default branch"), help_page_path('user/project/repository/branches', anchor: 'default-branch'))
+      - default_branch_docs = link_to(_("default branch"), help_page_path('user/project/repository/branches/index.md', anchor: 'default-branch'))
       = _("A subscription will trigger a new pipeline on the default branch of this project when a pipeline successfully completes for a new tag on the %{default_branch_docs} of the subscribed project.").html_safe % { default_branch_docs: default_branch_docs }
     %p
       = _("There is a limit of %{ci_project_subscriptions_limit} subscriptions from or to a project.").html_safe % { ci_project_subscriptions_limit: @project.actual_limits.ci_project_subscriptions }

ee/app/views/shared/empty_states/_geo_replication.html.haml

-- geo_troubleshooting_link = help_page_path('administration/geo/replication/troubleshooting.html')
+- geo_troubleshooting_link = help_page_path('administration/geo/replication/troubleshooting.md')
 
 .row.empty-state
   .col-12

ee/app/views/shared/promotions/_promote_advanced_search.html.haml

@@ -13,6 +13,6 @@
             = _('Improve search with Advanced Global Search and GitLab Enterprise Edition.')
         %p
           = _('The Advanced Global Search in GitLab is a powerful search service that saves you time. Instead of creating duplicate code and wasting time, you can now search for code within other teams that can help your own project.')
-          = link_to _('Read more'), help_page_path('user/search/advanced_global_search.html'), target: '_blank'
+          = link_to _('Read more'), help_page_path('user/search/advanced_global_search.md'), target: '_blank'
 
         = render 'shared/promotions/promotion_link_project'

ee/app/views/shared/promotions/_promote_audit_events.html.haml

@@ -9,6 +9,6 @@
         = _('Track your project with Audit Events.')
     %p
       = _('Audit Events is a way to keep track of important events that happened in GitLab.')
-      = link_to _('Read more'), help_page_path('administration/audit_events.html'), target: '_blank'
+      = link_to _('Read more'), help_page_path('administration/audit_events.md'), target: '_blank'
 
     = render 'shared/promotions/promotion_link_project'

ee/app/views/shared/promotions/_promote_burndown_charts.html.haml

@@ -15,6 +15,6 @@
             = s_('Promotions|Improve milestones with Burndown Charts.')
         %p
           = s_('Promotions|Burndown Charts are visual representations of the progress of completing a milestone. At a glance, you see the current state for the completion a given milestone. Without them, you would have to organize the data from the milestone and plot it yourself to have the same sense of progress.')
-          = link_to _('Read more'), help_page_path('user/project/milestones/burndown_charts.html'), target: '_blank'
+          = link_to _('Read more'), help_page_path('user/project/milestones/burndown_charts.md'), target: '_blank'
 
         = render 'shared/promotions/promotion_link_project'

ee/app/views/shared/promotions/_promote_group_webhooks.html.haml

@@ -9,6 +9,6 @@
         = _('Add Group Webhooks and GitLab Enterprise Edition.')
     %p
       = _('Webhooks allow you to trigger a URL if, for example, new code is pushed or a new issue is created. You can configure webhooks to listen for specific events like pushes, issues or merge requests. Group webhooks will apply to all projects in a group, allowing you to standardize webhook functionality across your entire group.')
-      = link_to _('Read more'), help_page_path('user/project/integrations/webhooks.html'), target: '_blank'
+      = link_to _('Read more'), help_page_path('user/project/integrations/webhooks.md'), target: '_blank'
     .prepend-top-15
       = render 'shared/promotions/promotion_link_project'

ee/app/views/shared/promotions/_promote_issue_board.html.haml

@@ -11,10 +11,10 @@
   %ul
     - unless @project.multiple_issue_boards_available?
       %li
-        = link_to _('Multiple issue boards'), help_page_path('user/project/issue_board.html', anchor:'use-cases-for-multiple-issue-boards'), target: '_blank'
+        = link_to _('Multiple issue boards'), help_page_path('user/project/issue_board.md', anchor:'use-cases-for-multiple-issue-boards'), target: '_blank'
     - unless @project.feature_available?(:scoped_issue_board)
       %li
-        = link_to _('Scoped issue boards'), help_page_path('user/project/issue_board.html', anchor:'configurable-issue-boards-starter'), target: '_blank'
+        = link_to _('Scoped issue boards'), help_page_path('user/project/issue_board.md', anchor:'configurable-issue-boards-starter'), target: '_blank'
   = render 'shared/promotions/promotion_link_project'
   .top-space
     %button.d-block.mb-3.btn.btn-default.btn-block#hide-btn{ :href => "#", "@click.stop" => "clearPromotionState" }

ee/app/views/shared/promotions/_promote_mr_features.html.haml

@@ -12,7 +12,7 @@
         %ul
           - unless @project.feature_available?(:merge_request_approvers)
             %li
-              = link_to _('Merge Request Approvals'), help_page_path('user/project/merge_requests/merge_request_approvals.html'), target: '_blank'
+              = link_to _('Merge Request Approvals'), help_page_path('user/project/merge_requests/merge_request_approvals.md'), target: '_blank'
               %p
                 = _('Merge request approvals allow you to set the number of necessary approvals and predefine a list of approvers that will need to approve every merge request in a project.')
 

ee/app/views/shared/promotions/_promote_repository_features.html.haml

@@ -19,12 +19,12 @@
                 Push Rules are defined per project so you can have different rules applied to different projects depends on your needs.
           - unless @project.feature_available?(:repository_mirrors)
             %li
-              = link_to 'Repository Mirroring', help_page_path('workflow/repository_mirroring.html'), target: '_blank'
+              = link_to 'Repository Mirroring', help_page_path('workflow/repository_mirroring.md'), target: '_blank'
               %p
                 Repository Mirroring is a way to mirror repositories from external sources. It can be used to mirror all branches, tags, and commits that you have in your repository.
           - unless @project.feature_available?(:protected_refs_for_users)
             %li
-              = link_to 'Better Protected Branches', help_page_path('user/project/protected_branches.html'), target: '_blank'
+              = link_to 'Better Protected Branches', help_page_path('user/project/protected_branches.md'), target: '_blank'
               %p
                 You can restrict access to protected branches by choosing a role (Maintainers, Developers) as well as certain users.
 

ee/app/views/shared/promotions/_promote_servicedesk.html.haml

@@ -9,4 +9,4 @@
         Improve customer support with GitLab Service Desk.
       %p
         GitLab Service Desk is a simple way to allow people to create issues in your GitLab instance without needing their own user account. It provides a unique email address for end users to create issues in a project, and replies can be sent either through the GitLab interface or by email. End users will only see the thread through email.
-        = link_to 'Read more', help_page_path('user/project/service_desk.html'), target: '_blank'
+        = link_to 'Read more', help_page_path('user/project/service_desk.md'), target: '_blank'

ee/changelogs/unreleased/update-links-for-documentation.yml

+---
+title: Replace .html with .md in documentation links
+merge_request: 35864
+author:
+type: other

spec/helpers/operations_helper_spec.rb

@@ -32,7 +32,7 @@ RSpec.describe OperationsHelper do
           'url' => alerts_service.url,
           'authorization_key' => nil,
           'form_path' => project_service_path(project, alerts_service),
-          'alerts_setup_url' => help_page_path('user/project/integrations/generic_alerts.html', anchor: 'setting-up-generic-alerts'),
+          'alerts_setup_url' => help_page_path('user/project/integrations/generic_alerts.md', anchor: 'setting-up-generic-alerts'),
           'alerts_usage_url' => project_alert_management_index_path(project),
           'prometheus_form_path' => project_service_path(project, prometheus_service),
           'prometheus_reset_key_path' => reset_alerting_token_project_settings_operations_path(project),