Merge branch 'quick-start-ci-route' into 'master'

Make "Get started with Builds" Help Page link work properly

`help_page_path('ci/quick_start', 'README')` causes a link to `https://gitlab.com/help/ci%2Fquick_start/README` which in turn breaks every relative link on the page. This remedies the problem.

That said, this is probably a horrible way of fixing this issue, *but* it does work. I can’t find much information on linking this deeply with Rails routes.

If anyone has suggestions as to a better way of handling this, I'll gladly take them. I tried a few different things, but none of them really worked.

Resolves #14872.

cc: @axil @rspeicher @elstamey

See merge request !3561

app/controllers/help_controller.rb

@@ -12,13 +12,12 @@ class HelpController < ApplicationController
   end
 
   def show
-    @category = clean_path_info(path_params[:category])
-    @file = path_params[:file]
+    @path = clean_path_info(path_params[:path])
 
     respond_to do |format|
       format.any(:markdown, :md, :html) do
         # Note: We are purposefully NOT using `Rails.root.join`
-        path = File.join(Rails.root, 'doc', @category, "#{@file}.md")
+        path = File.join(Rails.root, 'doc', "#{@path}.md")
 
         if File.exist?(path)
           @markdown = File.read(path)
@@ -33,7 +32,7 @@ class HelpController < ApplicationController
       # Allow access to images in the doc folder
       format.any(:png, :gif, :jpeg) do
         # Note: We are purposefully NOT using `Rails.root.join`
-        path = File.join(Rails.root, 'doc', @category, "#{@file}.#{params[:format]}")
+        path = File.join(Rails.root, 'doc', "#{@path}.#{params[:format]}")
 
         if File.exist?(path)
           send_file(path, disposition: 'inline')
@@ -57,8 +56,7 @@ class HelpController < ApplicationController
   private
 
   def path_params
-    params.require(:category)
-    params.require(:file)
+    params.require(:path)
 
     params
   end

app/helpers/search_helper.rb

@@ -43,15 +43,15 @@ module SearchHelper
   # Autocomplete results for internal help pages
   def help_autocomplete
     [
-      { category: "Help", label: "API Help",           url: help_page_path("api", "README") },
-      { category: "Help", label: "Markdown Help",      url: help_page_path("markdown", "markdown") },
-      { category: "Help", label: "Permissions Help",   url: help_page_path("permissions", "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: "SSH Keys Help",      url: help_page_path("ssh", "README") },
-      { category: "Help", label: "System Hooks Help",  url: help_page_path("system_hooks", "system_hooks") },
-      { category: "Help", label: "Webhooks Help",      url: help_page_path("web_hooks", "web_hooks") },
-      { category: "Help", label: "Workflow Help",      url: help_page_path("workflow", "README") },
+      { category: "Help", label: "API Help",           url: help_page_path("api/README") },
+      { category: "Help", label: "Markdown Help",      url: help_page_path("markdown/markdown") },
+      { category: "Help", label: "Permissions Help",   url: help_page_path("permissions/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: "SSH Keys Help",      url: help_page_path("ssh/README") },
+      { category: "Help", label: "System Hooks Help",  url: help_page_path("system_hooks/system_hooks") },
+      { category: "Help", label: "Webhooks Help",      url: help_page_path("web_hooks/web_hooks") },
+      { category: "Help", label: "Workflow Help",      url: help_page_path("workflow/README") },
     ]
   end
 

app/views/admin/appearances/_form.html.haml

@@ -13,7 +13,7 @@
     .col-sm-10
       = f.text_area :description, class: "form-control", rows: 10
       .hint
-        Description parsed with #{link_to "GitLab Flavored Markdown", help_page_path('markdown', 'markdown'), target: '_blank'}.
+        Description parsed with #{link_to "GitLab Flavored Markdown", help_page_path('markdown/markdown'), target: '_blank'}.
   .form-group
     = f.label :logo, class: 'control-label'
     .col-sm-10

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

@@ -38,11 +38,11 @@
             = source
         %span.help-block#import-sources-help
           Enabled sources for code import during project creation. OmniAuth must be configured for GitHub
-          = link_to "(?)", help_page_path("integration", "github")
+          = link_to "(?)", help_page_path("integration/github")
           , Bitbucket
-          = link_to "(?)", help_page_path("integration", "bitbucket")
+          = link_to "(?)", help_page_path("integration/bitbucket")
           and GitLab.com
-          = link_to "(?)", help_page_path("integration", "gitlab")
+          = link_to "(?)", help_page_path("integration/gitlab")
     .form-group
       %label.control-label.col-sm-2 Enabled Git access protocols
       .col-sm-10

app/views/admin/deploy_keys/new.html.haml

@@ -14,7 +14,7 @@
       .col-sm-10
         %p.light
           Paste a machine public key here. Read more about how to generate it
-          = link_to "here", help_page_path("ssh", "README")
+          = link_to "here", help_page_path("ssh/README")
         = f.text_area :key, class: "form-control thin_area", rows: 5
 
     .form-actions

app/views/admin/groups/show.html.haml

@@ -79,7 +79,7 @@
         .panel-body.form-holder
           %p.light
             Read more about project permissions
-            %strong= link_to "here", help_page_path("permissions", "permissions"), class: "vlink"
+            %strong= link_to "here", help_page_path("permissions/permissions"), class: "vlink"
 
           = form_tag members_update_admin_group_path(@group), id: "new_project_member", class: "bulk_import", method: :put  do
             %div

app/views/admin/hooks/index.html.haml

@@ -3,7 +3,7 @@
   System hooks
 
 %p.light
-  #{link_to "System hooks ", help_page_path("system_hooks", "system_hooks"), class: "vlink"} can be
+  #{link_to "System hooks ", help_page_path("system_hooks/system_hooks"), class: "vlink"} can be
   used for binding events when GitLab creates a User or Project.
 
 %hr

app/views/admin/projects/show.html.haml

@@ -132,7 +132,7 @@
               - else
                 passed.
 
-            = link_to icon('question-circle'), help_page_path('administration', 'repository_checks')
+            = link_to icon('question-circle'), help_page_path('administration/repository_checks')
 
           .form-group
             = f.submit 'Trigger repository check', class: 'btn btn-primary'

app/views/errors/access_denied.html.haml

@@ -3,4 +3,4 @@
 %h3 Access Denied
 %hr
 %p You are not allowed to access this page.
-%p Read more about project permissions #{link_to "here", help_page_path("permissions", "permissions"), class: "vlink"}
+%p Read more about project permissions #{link_to "here", help_page_path("permissions/permissions"), class: "vlink"}

app/views/groups/group_members/_new_group_member.html.haml

@@ -12,7 +12,7 @@
       = select_tag :access_level, options_for_select(GroupMember.access_level_roles, @group_member.access_level), class: "project-access-select select2"
       .help-block
         Read more about role permissions
-        %strong= link_to "here", help_page_path("permissions", "permissions"), class: "vlink"
+        %strong= link_to "here", help_page_path("permissions/permissions"), class: "vlink"
 
   .form-actions
     = f.submit 'Add users to group', class: "btn btn-create"

app/views/help/show.html.haml

-- page_title @file.humanize, *@category.split("/").reverse.map(&:humanize)
+- page_title @path.split("/").reverse.map(&:humanize)
 .documentation.wiki
   = markdown @markdown.gsub('$your_email', current_user.try(:email) || "email@example.com")

app/views/help/ui.html.haml

@@ -549,4 +549,4 @@
     %li wiki page
     %li help page
 
-  You can check how markdown rendered at #{link_to 'Markdown help page', help_page_path("markdown", "markdown")}.
+  You can check how markdown rendered at #{link_to 'Markdown help page', help_page_path("markdown/markdown")}.

app/views/import/github/new.html.haml

@@ -38,6 +38,6 @@
       As an administrator you may like to configure
     - else
       Consider asking your GitLab administrator to configure
-    = link_to 'GitHub integration', help_page_path("integration", "github")
+    = link_to 'GitHub integration', help_page_path("integration/github")
     which will allow login via GitHub and allow importing projects without
     generating a Personal Access Token.

app/views/profiles/keys/index.html.haml

@@ -11,7 +11,7 @@
       Add an SSH key
     %p.profile-settings-content
       Before you can add an SSH key you need to
-      = link_to "generate it.", help_page_path("ssh", "README")
+      = link_to "generate it.", help_page_path("ssh/README")
     = render 'form'
     %hr
     %h5

app/views/profiles/preferences/show.html.haml

@@ -43,12 +43,12 @@
     .form-group
       = f.label :dashboard, class: 'label-light' do
         Default Dashboard
-        = link_to('(?)', help_page_path('profile', 'preferences') + '#default-dashboard', target: '_blank')
+        = link_to('(?)', help_page_path('profile/preferences') + '#default-dashboard', target: '_blank')
       = f.select :dashboard, dashboard_choices, {}, class: 'form-control'
     .form-group
       = f.label :project_view, class: 'label-light' do
         Project view
-        = link_to('(?)', help_page_path('profile', 'preferences') + '#default-project-view', target: '_blank')
+        = link_to('(?)', help_page_path('profile/preferences') + '#default-project-view', target: '_blank')
       = f.select :project_view, project_view_choices, {}, class: 'form-control'
       .help-block
         Choose what content you want to see on a project's home page.

app/views/profiles/two_factor_auths/show.html.haml

@@ -14,7 +14,7 @@
     - else
       %p
         Download the Google Authenticator application from App Store or Google Play Store and scan this code.
-        More information is available in the #{link_to('documentation', help_page_path('profile', 'two_factor_authentication'))}.
+        More information is available in the #{link_to('documentation', help_page_path('profile/two_factor_authentication'))}.
       .row.append-bottom-10
         .col-md-3
           = raw @qr_code

app/views/projects/_bitbucket_import_modal.html.haml

@@ -10,4 +10,4 @@
           as administrator you need to configure
         - else
           ask your GitLab administrator to configure
-        == #{link_to 'OAuth integration', help_page_path("integration", "bitbucket")}.
+        == #{link_to 'OAuth integration', help_page_path("integration/bitbucket")}.

app/views/projects/_builds_settings.html.haml

@@ -4,7 +4,7 @@
   - unless @repository.gitlab_ci_yml
     .form-group
       %p Builds need to be configured before you can begin using Continuous Integration.
-      = link_to 'Get started with Builds', help_page_path('ci/quick_start', 'README'), class: 'btn btn-info'
+      = link_to 'Get started with Builds', help_page_path('ci/quick_start/README'), class: 'btn btn-info'
   .form-group
     %p Get recent application code using the following command:
     .radio

app/views/projects/_gitlab_import_modal.html.haml

@@ -10,4 +10,4 @@
           as administrator you need to configure
         - else
           ask your GitLab administrator to configure
-        == #{link_to 'OAuth integration', help_page_path("integration", "gitlab")}.
+        == #{link_to 'OAuth integration', help_page_path("integration/gitlab")}.

app/views/projects/_merge_request_settings.html.haml

@@ -8,4 +8,4 @@
         %strong Only allow merge requests to be merged if the build succeeds
       .help-block
         Builds need to be configured to enable this feature.
-        = link_to icon('question-circle'), help_page_path('workflow', 'merge_requests', anchor: 'only-allow-merge-requests-to-be-merged-if-the-build-succeeds')
+        = link_to icon('question-circle'), help_page_path('workflow/merge_requests', anchor: 'only-allow-merge-requests-to-be-merged-if-the-build-succeeds')

app/views/projects/builds/index.html.haml

@@ -31,7 +31,7 @@
             data: { confirm: 'Are you sure?' }, class: 'btn btn-danger', method: :post
 
         - unless @repository.gitlab_ci_yml
-          = link_to 'Get started with Builds', help_page_path('ci/quick_start', 'README'), class: 'btn btn-info'
+          = link_to 'Get started with Builds', help_page_path('ci/quick_start/README'), class: 'btn btn-info'
 
         = link_to ci_lint_path, class: 'btn btn-default' do
           %span CI Lint

app/views/projects/deploy_keys/_form.html.haml

@@ -9,5 +9,5 @@
   .form-group
     %p.light.append-bottom-0
       Paste a machine public key here. Read more about how to generate it
-      = link_to "here", help_page_path("ssh", "README")
+      = link_to "here", help_page_path("ssh/README")
   = f.submit "Add key", class: "btn-create btn"

app/views/projects/edit.html.haml

@@ -23,7 +23,7 @@
         .form-group.project-visibility-level-holder
           = f.label :visibility_level, class: 'label-light' do
             Visibility Level
-            = link_to "(?)", help_page_path("public_access", "public_access")
+            = link_to "(?)", help_page_path("public_access/public_access")
           - if can_change_visibility_level?(@project, current_user)
             = render('shared/visibility_radios', model_method: :visibility_level, form: f, selected_level: @project.visibility_level, form_model: @project)
           - else

app/views/projects/environments/index.html.haml

@@ -17,7 +17,7 @@
         Environments are places where code gets deployed, such as staging or production.
         %br
         = succeed "." do
-          = link_to "Read more about environments", help_page_path("ci", "environments")
+          = link_to "Read more about environments", help_page_path("ci/environments")
       - if can?(current_user, :create_environment, @project)
         = link_to new_namespace_project_environment_path(@project.namespace, @project), class: 'btn btn-create' do
           New environment

app/views/projects/environments/new.html.haml

@@ -7,6 +7,6 @@
     %p
       Environments allow you to track deployments of your application
       = succeed "." do
-        = link_to "Read more about environments", help_page_path("ci", "environments")
+        = link_to "Read more about environments", help_page_path("ci/environments")
 
   = render 'form'

app/views/projects/environments/show.html.haml

@@ -20,7 +20,7 @@
         Define environments in the deploy stage(s) in
         %code .gitlab-ci.yml
         to track deployments here.
-      = link_to "Read more", help_page_path("ci", "environments"), class: "btn btn-success"
+      = link_to "Read more", help_page_path("ci/environments"), class: "btn btn-success"
   - else
     .table-holder
       %table.table.environments

app/views/projects/new.html.haml

@@ -107,7 +107,7 @@
         .form-group.project-visibility-level-holder
           = f.label :visibility_level, class: 'label-light' do
             Visibility Level
-            = link_to "(?)", help_page_path("public_access", "public_access")
+            = link_to "(?)", help_page_path("public_access/public_access")
           = render('shared/visibility_radios', model_method: :visibility_level, form: f, selected_level: @project.visibility_level, form_model: @project)
 
         = f.submit 'Create project', class: "btn btn-create project-submit", tabindex: 4

app/views/projects/notes/_hints.html.haml

 .comment-toolbar.clearfix
   .toolbar-text
     Styling with
-    = link_to 'Markdown', help_page_path('markdown', 'markdown'), target: '_blank', tabindex: -1
+    = link_to 'Markdown', help_page_path('markdown/markdown'), target: '_blank', tabindex: -1
     is supported
   %button.toolbar-button.markdown-selector{ type: 'button', tabindex: '-1' }
     = icon('file-image-o', class: 'toolbar-button-icon')

app/views/projects/pipelines/index.html.haml

@@ -31,7 +31,7 @@
           New pipeline
 
         - unless @repository.gitlab_ci_yml
-          = link_to 'Get started with Pipelines', help_page_path('ci/quick_start', 'README'), class: 'btn btn-info'
+          = link_to 'Get started with Pipelines', help_page_path('ci/quick_start/README'), class: 'btn btn-info'
 
         = link_to ci_lint_path, class: 'btn btn-default' do
           %span CI Lint

app/views/projects/project_members/_new_project_member.html.haml

@@ -12,7 +12,7 @@
       = select_tag :access_level, options_for_select(ProjectMember.access_level_roles, @project_member.access_level), class: "project-access-select select2"
       .help-block
         Read more about role permissions
-        %strong= link_to "here", help_page_path("permissions", "permissions"), class: "vlink"
+        %strong= link_to "here", help_page_path("permissions/permissions"), class: "vlink"
 
   .form-actions
     = f.submit 'Add users to project', class: "btn btn-create"

app/views/projects/protected_branches/index.html.haml

@@ -8,10 +8,10 @@
     %p.prepend-top-20
       Protected branches are designed to:
       %ul
-        %li prevent pushes from everybody except #{link_to "masters", help_page_path("permissions", "permissions"), class: "vlink"}
+        %li prevent pushes from everybody except #{link_to "masters", help_page_path("permissions/permissions"), class: "vlink"}
         %li prevent anyone from force pushing to the branch
         %li prevent anyone from deleting the branch
-      %p.append-bottom-0 Read more about #{link_to "project permissions", help_page_path("permissions", "permissions"), class: "underlined-link"}
+      %p.append-bottom-0 Read more about #{link_to "project permissions", help_page_path("permissions/permissions"), class: "underlined-link"}
   .col-lg-9
     %h5.prepend-top-0
       Protect a branch
@@ -23,7 +23,7 @@
           = f.label :name, "Branch", class: "label-light"
           = render partial: "dropdown", locals: { f: f }
           %p.help-block
-            = link_to "Wildcards", help_page_path(category: 'workflow', file: 'protected_branches', format: 'md', anchor: "wildcard-protected-branches")
+            = link_to "Wildcards", help_page_path('workflow/protected_branches', anchor: "wildcard-protected-branches")
             such as
             %code *-stable
             or

app/views/shared/_visibility_level.html.haml

 .form-group.project-visibility-level-holder
   = f.label :visibility_level, class: 'control-label' do
     Visibility Level
-    = link_to "(?)", help_page_path("public_access", "public_access")
+    = link_to "(?)", help_page_path("public_access/public_access")
   .col-sm-10
     - if can_change_visibility_level
       = render('shared/visibility_radios', model_method: :visibility_level, form: f, selected_level: visibility_level, form_model: form_model)

app/views/shared/web_hooks/_form.html.haml

@@ -6,7 +6,7 @@
     %h4.prepend-top-0
       = page_title
     %p
-      #{link_to "Webhooks", help_page_path("web_hooks", "web_hooks")} can be
+      #{link_to "Webhooks", help_page_path("web_hooks/web_hooks")} can be
       used for binding events when something is happening within the project.
   .col-lg-9.append-bottom-default
     = form_for hook, as: :hook, url: polymorphic_path(url_components + [:hooks]) do |f|

config/routes.rb

@@ -89,8 +89,9 @@ Rails.application.routes.draw do
   mount Grack::AuthSpawner, at: '/', constraints: lambda { |request| /[-\/\w\.]+\.git\/(info\/lfs|gitlab-lfs)/.match(request.path_info) }, via: [:get, :post, :put]
 
   # Help
+  
   get 'help'                  => 'help#index'
-  get 'help/:category/:file'  => 'help#show', as: :help_page, constraints: { category: /.*/, file: /[^\/\.]+/ }
+  get 'help/*path'            => 'help#show', as: :help_page
   get 'help/shortcuts'
   get 'help/ui' => 'help#ui'
 

features/steps/dashboard/help.rb

@@ -8,7 +8,7 @@ class Spinach::Features::DashboardHelp < Spinach::FeatureSteps
   end
 
   step 'I visit the "Rake Tasks" help page' do
-    visit help_page_path("raketasks", "maintenance")
+    visit help_page_path("raketasks/maintenance")
   end
 
   step 'I should see "Rake Tasks" page markdown rendered' do

spec/controllers/help_controller_spec.rb

@@ -11,7 +11,7 @@ describe HelpController do
     context 'for Markdown formats' do
       context 'when requested file exists' do
         before do
-          get :show, category: 'ssh', file: 'README', format: :md
+          get :show, path: 'ssh/README', format: :md
         end
 
         it 'assigns to @markdown' do
@@ -26,7 +26,7 @@ describe HelpController do
 
       context 'when requested file is missing' do
         it 'renders not found' do
-          get :show, category: 'foo', file: 'bar', format: :md
+          get :show, path: 'foo/bar', format: :md
           expect(response).to be_not_found
         end
       end
@@ -36,8 +36,7 @@ describe HelpController do
       context 'when requested file exists' do
         it 'renders the raw file' do
           get :show,
-              category: 'workflow/protected_branches',
-              file: 'protected_branches1',
+              path: 'workflow/protected_branches/protected_branches1',
               format: :png
           expect(response).to be_success
           expect(response.content_type).to eq 'image/png'
@@ -48,8 +47,7 @@ describe HelpController do
       context 'when requested file is missing' do
         it 'renders not found' do
           get :show,
-              category: 'foo',
-              file: 'bar',
+              path: 'foo/bar',
               format: :png
           expect(response).to be_not_found
         end
@@ -59,8 +57,7 @@ describe HelpController do
     context 'for other formats' do
       it 'always renders not found' do
         get :show,
-            category: 'ssh',
-            file: 'README',
+            path: 'ssh/README',
             format: :foo
         expect(response).to be_not_found
       end

spec/features/help_pages_spec.rb

@@ -6,7 +6,7 @@ describe 'Help Pages', feature: true do
       login_as :user
     end
     it 'replace the variable $your_email with the email of the user' do
-      visit help_page_path('ssh', 'README')
+      visit help_page_path('ssh/README')
       expect(page).to have_content("ssh-keygen -t rsa -C \"#{@user.email}\"")
     end
   end

spec/routing/routing_spec.rb

@@ -98,7 +98,7 @@ describe SnippetsController, "routing" do
 end
 
 #            help GET /help(.:format)                 help#index
-#       help_page GET /help/:category/:file(.:format) help#show {:category=>/.*/, :file=>/[^\/\.]+/}
+#       help_page GET /help/*path(.:format)           help#show
 #  help_shortcuts GET /help/shortcuts(.:format)       help#shortcuts
 #         help_ui GET /help/ui(.:format)              help#ui
 describe HelpController, "routing" do
@@ -109,23 +109,19 @@ describe HelpController, "routing" do
   it 'to #show' do
     path = '/help/markdown/markdown.md'
     expect(get(path)).to route_to('help#show',
-                                  category: 'markdown',
-                                  file: 'markdown',
+                                  path: 'markdown/markdown',
                                   format: 'md')
 
     path = '/help/workflow/protected_branches/protected_branches1.png'
     expect(get(path)).to route_to('help#show',
-                                  category: 'workflow/protected_branches',
-                                  file: 'protected_branches1',
+                                  path: 'workflow/protected_branches/protected_branches1',
                                   format: 'png')
-  end
-
-  it 'to #shortcuts' do
-    expect(get('/help/shortcuts')).to route_to('help#shortcuts')
-  end
-
-  it 'to #ui' do
-    expect(get('/help/ui')).to route_to('help#ui')
+    path = '/help/shortcuts'
+    expect(get(path)).to route_to('help#show',
+                                  path: 'shortcuts')
+    path = '/help/ui'
+    expect(get(path)).to route_to('help#show',
+                                  path: 'ui')
   end
 end