Class: HelpController
- Inherits:
-
ApplicationController
- Object
- ActionController::Base
- ApplicationController
- HelpController
- Defined in:
- app/controllers/help_controller.rb
Constant Summary collapse
- YAML_FRONT_MATTER_REGEXP =
Taken from Jekyll github.com/jekyll/jekyll/blob/3.5-stable/lib/jekyll/document.rb#L13
/\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
Constants inherited from ApplicationController
ApplicationController::DEFAULT_GITLAB_CACHE_CONTROL
Constants included from Gitlab::Logging::CloudflareHelper
Gitlab::Logging::CloudflareHelper::CLOUDFLARE_CUSTOM_HEADERS
Constants included from Gitlab::NoCacheHeaders
Gitlab::NoCacheHeaders::DEFAULT_GITLAB_NO_CACHE_HEADERS
Instance Method Summary collapse
Methods inherited from ApplicationController
#not_found, #redirect_back_or_default, #render, #route_not_found
Methods included from Gitlab::Utils::StrongMemoize
#clear_memoization, #strong_memoize, #strong_memoized?
Methods included from Gitlab::Logging::CloudflareHelper
#store_cloudflare_headers!, #valid_cloudflare_header?
Methods included from Impersonation
Methods included from InitializesCurrentUserMode
Methods included from Gitlab::Experimentation::ControllerConcern
#experiment_enabled?, #experiment_tracking_category_and_group, #frontend_experimentation_tracking_data, #record_experiment_user, #set_experimentation_subject_id_cookie, #track_experiment_event
Methods included from SessionsHelper
#limit_session_time, #unconfirmed_email?
Methods included from SessionlessAuthentication
#authenticate_sessionless_user!, #sessionless_bypass_admin_mode!, #sessionless_sign_in, #sessionless_user?
Methods included from Gitlab::SearchContext::ControllerConcern
Methods included from EnforcesTwoFactorAuthentication
#check_two_factor_requirement, #current_user_requires_two_factor?, #skip_two_factor?, #two_factor_authentication_reason, #two_factor_authentication_required?, #two_factor_grace_period, #two_factor_grace_period_expired?, #two_factor_skippable?, #two_factor_verifier
Methods included from WorkhorseHelper
#send_artifacts_entry, #send_git_archive, #send_git_blob, #send_git_diff, #send_git_patch, #set_workhorse_internal_api_content_type, #workhorse_set_content_type!
Methods included from SafeParamsHelper
Methods included from PageLayoutHelper
#blank_container, #container_class, #favicon, #fluid_layout, #header_title, #nav, #page_card_attributes, #page_card_meta_tags, #page_description, #page_image, #page_title, #search_context, #sidebar
Methods included from GitlabRoutingHelper
#approve_access_request_group_member_path, #approve_access_request_project_member_path, #artifacts_action_path, #commit_url, #commits_url, #edit_milestone_path, #edit_pipeline_schedule_path, #environment_delete_path, #environment_metrics_path, #environment_path, #expose_fast_artifacts_path, #fast_browse_project_job_artifacts_path, #fast_download_project_job_artifacts_path, #fast_keep_project_job_artifacts_path, #gitlab_dashboard_snippets_path, #gitlab_raw_snippet_blob_path, #gitlab_raw_snippet_blob_url, #gitlab_raw_snippet_path, #gitlab_raw_snippet_url, #gitlab_snippet_note_path, #gitlab_snippet_note_url, #gitlab_snippet_notes_path, #gitlab_snippet_notes_url, #gitlab_snippet_path, #gitlab_snippet_url, #gitlab_toggle_award_emoji_snippet_note_path, #gitlab_toggle_award_emoji_snippet_note_url, #gitlab_toggle_award_emoji_snippet_path, #gitlab_toggle_award_emoji_snippet_url, #group_member_path, #group_members_url, #issue_path, #issue_url, #leave_group_members_path, #leave_project_members_path, #merge_request_path, #merge_request_url, #pipeline_job_url, #pipeline_path, #pipeline_schedule_path, #pipeline_schedules_path, #pipeline_url, #play_pipeline_schedule_path, #preview_markdown_path, #project_commits_path, #project_member_path, #project_members_url, #project_ref_path, #project_tree_path, #request_access_group_members_path, #request_access_project_members_path, #resend_invite_group_member_path, #resend_invite_project_member_path, #take_ownership_pipeline_schedule_path, #toggle_award_emoji_personal_snippet_path, #toggle_award_emoji_project_project_snippet_path, #toggle_award_emoji_project_project_snippet_url, #toggle_subscription_path, #wiki_page_path, #wiki_path
Methods included from API::Helpers::RelatedResourcesHelpers
#expose_path, #expose_url, #issues_available?, #mrs_available?
Methods included from Gitlab::NoCacheHeaders
Methods included from Gitlab::GonHelper
#add_gon_variables, #default_avatar_url, #push_frontend_feature_flag
Methods included from WebpackHelper
#webpack_bundle_tag, #webpack_controller_bundle_tags, #webpack_entrypoint_paths, #webpack_public_host, #webpack_public_path
Methods included from StartupCssHelper
Instance Method Details
#index ⇒ Object
12 13 14 15 16 17 18 19 20 21 22 |
# File 'app/controllers/help_controller.rb', line 12 def index # Remove YAML frontmatter so that it doesn't look weird @help_index = File.read(Rails.root.join('doc', 'README.md')).sub(YAML_FRONT_MATTER_REGEXP, '') # Prefix Markdown links with `help/` unless they are external links. # '//' not necessarily part of URL, e.g., mailto:[email protected] # See https://rubular.com/r/DFHZl5w8d3bpzV @help_index.gsub!(%r{(?<delim>\]\()(?!\w+:)(?!/)(?<link>[^\)\(]+\))}) do "#{$~[:delim]}#{Gitlab.config.gitlab.relative_url_root}/help/#{$~[:link]}" end end |
#instance_configuration ⇒ Object
63 64 65 |
# File 'app/controllers/help_controller.rb', line 63 def instance_configuration @instance_configuration = InstanceConfiguration.new end |
#shortcuts ⇒ Object
60 61 |
# File 'app/controllers/help_controller.rb', line 60 def shortcuts end |
#show ⇒ Object
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'app/controllers/help_controller.rb', line 24 def show @path = Rack::Utils.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` because of https://gitlab.com/gitlab-org/gitlab/-/issues/216028. path = File.join(Rails.root, 'doc', "#{@path}.md") if File.exist?(path) # Remove YAML frontmatter so that it doesn't look weird @markdown = File.read(path).gsub(YAML_FRONT_MATTER_REGEXP, '') render 'show.html.haml' else # Force template to Haml render 'errors/not_found.html.haml', layout: 'errors', status: :not_found end end # Allow access to specific media files in the doc folder format.any(:png, :gif, :jpeg, :mp4, :mp3) do # Note: We are purposefully NOT using `Rails.root.join` because of https://gitlab.com/gitlab-org/gitlab/-/issues/216028. path = File.join(Rails.root, 'doc', "#{@path}.#{params[:format]}") if File.exist?(path) send_file(path, disposition: 'inline') else head :not_found end end # Any other format we don't recognize, just respond 404 format.any { head :not_found } end end |