Merge branch 'UI-docs-links-to-readmes' into 'master'

Change links to docs from readme to index

See merge request gitlab-org/gitlab!66129

app/helpers/ci/pipeline_editor_helper.rb

@@ -21,7 +21,7 @@ module Ci
         "empty-state-illustration-path" => image_path('illustrations/empty-state/empty-dag-md.svg'),
         "initial-branch-name" => initial_branch,
         "lint-help-page-path" => help_page_path('ci/lint', anchor: 'validate-basic-logic-and-syntax'),
-        "needs-help-page-path" => help_page_path('ci/yaml/README', anchor: 'needs'),
+        "needs-help-page-path" => help_page_path('ci/yaml/index', anchor: 'needs'),
         "new-merge-request-path" => namespace_project_new_merge_request_path,
         "pipeline_etag" => latest_commit ? graphql_etag_pipeline_sha_path(commit_sha) : '',
         "pipeline-page-path" => project_pipelines_path(project),
@@ -30,7 +30,7 @@ module Ci
         "project-namespace" => project.namespace.full_path,
         "runner-help-page-path" => help_page_path('ci/runners/index'),
         "total-branches" => project.repository.branches.length,
-        "yml-help-page-path" => help_page_path('ci/yaml/README')
+        "yml-help-page-path" => help_page_path('ci/yaml/index')
       }
     end
   end

app/helpers/ide_helper.rb

@@ -8,7 +8,7 @@ module IdeHelper
       'committed-state-svg-path' => image_path('illustrations/multi-editor_all_changes_committed_empty.svg'),
       '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'),
+      'ci-help-page-path' => help_page_path('ci/quick_start/index'),
       '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,

app/helpers/search_helper.rb

@@ -189,7 +189,7 @@ module SearchHelper
       { category: "Help", label: _("Markdown Help"),      url: help_page_path("user/markdown") },
       { category: "Help", label: _("Permissions Help"),   url: help_page_path("user/permissions") },
       { category: "Help", label: _("Public Access Help"), url: help_page_path("public_access/public_access") },
-      { category: "Help", label: _("Rake Tasks Help"),    url: help_page_path("raketasks/README") },
+      { category: "Help", label: _("Rake Tasks Help"),    url: help_page_path("raketasks/index") },
       { category: "Help", label: _("SSH Keys Help"),      url: help_page_path("ssh/index") },
       { category: "Help", label: _("System Hooks Help"),  url: help_page_path("system_hooks/system_hooks") },
       { category: "Help", label: _("Webhooks Help"),      url: help_page_path("user/project/integrations/webhooks") }

app/serializers/build_details_entity.rb

@@ -133,7 +133,7 @@ class BuildDetailsEntity < JobEntity
   def callout_message
     return super unless build.failure_reason.to_sym == :missing_dependency_failure
 
-    docs_url = "https://docs.gitlab.com/ee/ci/yaml/README.html#dependencies"
+    docs_url = "https://docs.gitlab.com/ee/ci/yaml/index.html#dependencies"
 
     [
       failure_message,

app/views/projects/blob/viewers/_gitlab_ci_yml.html.haml

@@ -6,4 +6,4 @@
   = s_('Pipelines|This GitLab CI configuration is invalid:')
   = viewer.validation_message(project: @project, sha: @commit.sha, user: @current_user)
 
-= link_to _('Learn more'), help_page_path('ci/yaml/README')
+= link_to _('Learn more'), help_page_path('ci/yaml/index')

app/views/projects/blob/viewers/_gitlab_ci_yml_loading.html.haml

 = loading_icon(css_class: "gl-vertical-align-text-bottom mr-1")
 = s_('Pipelines|Validating GitLab CI configuration…')
 
-= link_to _('Learn more'), help_page_path('ci/yaml/README')
+= link_to _('Learn more'), help_page_path('ci/yaml/index')

data/whats_new/202102180001_13_09.yml

@@ -7,7 +7,7 @@
   self-managed: true
   gitlab-com: true
   packages: [Free, Premium, Ultimate]
-  url: https://docs.gitlab.com/ee/ci/yaml/README.html#reference-tags
+  url: https://docs.gitlab.com/ee/ci/yaml/index.html#reference-tags
   image_url: https://about.gitlab.com/images/13_9/reference.png
   published_at: 2021-02-22
   release: 13.9

data/whats_new/202104220001_13_11.yml

@@ -48,7 +48,7 @@
   self-managed: true
   gitlab-com: true
   packages: [Free, Premium, Ultimate]
-  url: https://docs.gitlab.com/ee/ci/yaml/README.html#multiple-caches
+  url: https://docs.gitlab.com/ee/ci/yaml/index.html#multiple-caches
   image_url:  https://about.gitlab.com/images/13_11/cache.png
   published_at: 2021-04-22
   release: 13.11

data/whats_new/202105220001_13_12.yml

@@ -35,7 +35,7 @@
   self-managed: true
   gitlab-com: true
   packages: [Free, Premium, Ultimate]
-  url: https://docs.gitlab.com/ee/ci/yaml/README.html#artifactsexpire_in
+  url: https://docs.gitlab.com/ee/ci/yaml/index.html#artifactsexpire_in
   image_url: https://about.gitlab.com/images/growth/verify.png
   published_at: 2021-05-22
   release: 13.12

ee/lib/system_check/geo/enabled_check.rb

@@ -14,7 +14,7 @@ module SystemCheck
           'Follow Geo setup instructions to configure primary and secondary nodes'
         )
 
-        for_more_information('doc/gitlab-geo/README.md')
+        for_more_information('doc/administration/geo/index.md')
       end
     end
   end

ee/lib/system_check/geo/http_clone_enabled_check.rb

@@ -14,7 +14,7 @@ module SystemCheck
           'Enable HTTP/HTTPS repository cloning for Geo repository synchronization'
         )
 
-        for_more_information('doc/gitlab-geo/README.md')
+        for_more_information('doc/administration/geo/index.md')
       end
 
       private

ee/lib/system_check/geo/http_connection_check.rb

@@ -80,7 +80,7 @@ module SystemCheck
       end
 
       def see_custom_certificate_doc
-        'https://docs.gitlab.com/omnibus/common_installation_problems/README.html#using-self-signed-certificate-or-custom-certificate-authorities'
+        'https://docs.gitlab.com/omnibus/common_installation_problems/index.html#using-self-signed-certificate-or-custom-certificate-authorities'
       end
     end
   end

lib/gitlab/ci/templates/Bash.gitlab-ci.yml

@@ -3,7 +3,7 @@
 # This specific template is located at:
 # https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Bash.gitlab-ci.yml
 
-# See https://docs.gitlab.com/ee/ci/yaml/README.html for all available options
+# See https://docs.gitlab.com/ee/ci/yaml/index.html for all available options
 
 # you can delete this line if you're not using Docker
 image: busybox:latest

lib/gitlab/ci/templates/Django.gitlab-ci.yml

@@ -18,7 +18,7 @@ variables:
   POSTGRES_DB: database_name
 
 # This folder is cached between builds
-# http://docs.gitlab.com/ee/ci/yaml/README.html#cache
+# https://docs.gitlab.com/ee/ci/yaml/index.html#cache
 cache:
   paths:
     - ~/.cache/pip/

lib/gitlab/ci/templates/Getting-Started.gitlab-ci.yml

@@ -10,7 +10,7 @@
 # A pipeline is composed of independent jobs that run scripts, grouped into stages.
 # Stages run in sequential order, but jobs within stages run in parallel.
 #
-# For more information, see: https://docs.gitlab.com/ee/ci/yaml/README.html#stages
+# For more information, see: https://docs.gitlab.com/ee/ci/yaml/index.html#stages
 
 stages:          # List of stages for jobs, and their order of execution
   - build

lib/gitlab/ci/templates/Laravel.gitlab-ci.yml

@@ -18,7 +18,7 @@ variables:
   MYSQL_ROOT_PASSWORD: secret
 
 # This folder is cached between builds
-# http://docs.gitlab.com/ee/ci/yaml/README.html#cache
+# https://docs.gitlab.com/ee/ci/yaml/index.html#cache
 cache:
   paths:
     - vendor/

lib/gitlab/ci/templates/Nodejs.gitlab-ci.yml

@@ -16,7 +16,7 @@ services:
   - postgres:latest
 
 # This folder is cached between builds
-# http://docs.gitlab.com/ee/ci/yaml/README.html#cache
+# https://docs.gitlab.com/ee/ci/yaml/index.html#cache
 cache:
   paths:
     - node_modules/

lib/gitlab/ci/templates/Pages/Gatsby.gitlab-ci.yml

@@ -6,7 +6,7 @@
 image: node:latest
 
 # This folder is cached between builds
-# http://docs.gitlab.com/ee/ci/yaml/README.html#cache
+# https://docs.gitlab.com/ee/ci/yaml/index.html#cache
 cache:
   paths:
     - node_modules/

lib/gitlab/ci/templates/Security/Cluster-Image-Scanning.gitlab-ci.yml

@@ -8,7 +8,7 @@
 # - A `test` stage to be present in the pipeline.
 # - You must define the `CIS_KUBECONFIG` variable to allow analyzer to connect to your Kubernetes cluster and fetch found vulnerabilities.
 #
-# Configure container scanning with CI/CD variables (https://docs.gitlab.com/ee/ci/variables/README.html).
+# Configure container scanning with CI/CD variables (https://docs.gitlab.com/ee/ci/variables/index.html).
 # List of available variables: https://docs.gitlab.com/ee/user/application_security/cluster_image_scanning/#available-variables
 
 variables:

lib/gitlab/email/message/in_product_marketing/create.rb

@@ -84,7 +84,7 @@ module Gitlab
           end
 
           def basics_link
-            link(s_('InProductMarketing|Git basics'), help_page_url('gitlab-basics/README'))
+            link(s_('InProductMarketing|Git basics'), help_page_url('gitlab-basics/index'))
           end
 
           def import_link

lib/gitlab/email/message/in_product_marketing/verify.rb

@@ -72,7 +72,7 @@ module Gitlab
           end
 
           def quick_start_link
-            link(s_('InProductMarketing|quick start guide'), help_page_url('ci/quick_start/README'))
+            link(s_('InProductMarketing|quick start guide'), help_page_url('ci/quick_start/index'))
           end
 
           def performance_link

lib/gitlab/slash_commands/presenters/help.rb

@@ -48,7 +48,7 @@ module Gitlab
              *Documentation*
 
              For more information about GitLab chatops, refer to its
-             documentation: https://docs.gitlab.com/ee/ci/chatops/README.html.
+             documentation: https://docs.gitlab.com/ee/ci/chatops/index.html.
           MESSAGE
 
           message

spec/helpers/ci/pipeline_editor_helper_spec.rb

@@ -47,7 +47,7 @@ RSpec.describe Ci::PipelineEditorHelper do
           "empty-state-illustration-path" => 'foo',
           "initial-branch-name" => nil,
           "lint-help-page-path" => help_page_path('ci/lint', anchor: 'validate-basic-logic-and-syntax'),
-          "needs-help-page-path" => help_page_path('ci/yaml/README', anchor: 'needs'),
+          "needs-help-page-path" => help_page_path('ci/yaml/index', anchor: 'needs'),
           "new-merge-request-path" => '/mock/project/-/merge_requests/new',
           "pipeline_etag" => graphql_etag_pipeline_sha_path(project.commit.sha),
           "pipeline-page-path" => project_pipelines_path(project),
@@ -56,7 +56,7 @@ RSpec.describe Ci::PipelineEditorHelper do
           "project-namespace" => project.namespace.full_path,
           "runner-help-page-path" => help_page_path('ci/runners/index'),
           "total-branches" => project.repository.branches.length,
-          "yml-help-page-path" => help_page_path('ci/yaml/README')
+          "yml-help-page-path" => help_page_path('ci/yaml/index')
         })
       end
     end
@@ -74,7 +74,7 @@ RSpec.describe Ci::PipelineEditorHelper do
           "empty-state-illustration-path" => 'foo',
           "initial-branch-name" => nil,
           "lint-help-page-path" => help_page_path('ci/lint', anchor: 'validate-basic-logic-and-syntax'),
-          "needs-help-page-path" => help_page_path('ci/yaml/README', anchor: 'needs'),
+          "needs-help-page-path" => help_page_path('ci/yaml/index', anchor: 'needs'),
           "new-merge-request-path" => '/mock/project/-/merge_requests/new',
           "pipeline_etag" => '',
           "pipeline-page-path" => project_pipelines_path(project),
@@ -83,7 +83,7 @@ RSpec.describe Ci::PipelineEditorHelper do
           "project-namespace" => project.namespace.full_path,
           "runner-help-page-path" => help_page_path('ci/runners/index'),
           "total-branches" => 0,
-          "yml-help-page-path" => help_page_path('ci/yaml/README')
+          "yml-help-page-path" => help_page_path('ci/yaml/index')
         })
       end
     end