Do not show YAML frontmatter for doc pages under /help

We recently started adding YAML frontmatter in docs so that we can show more information, but that only works for the docs portal at docs.gitlab.com. For example, we want to add a last_updated entry https://gitlab.com/gitlab-org/gitlab-ce/issues/37677 Whereas this is useful for the docs portal, it looks ugly for docs under /help.

Do not show YAML frontmatter for doc pages under /help
52ddf8e6 · Achilleas Pipinellis · Achilleas Pipinellis · 727f51b8 · 52ddf8e6
Unverified Commit 52ddf8e6 authored Sep 18, 2017 by Achilleas Pipinellis Committed by Achilleas Pipinellis Sep 19, 2017
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 2 deletions

help_controller.rb app/controllers/help_controller.rb +8 -2

No files found.
--- a/app/controllers/help_controller.rb
+++ b/app/controllers/help_controller.rb
@@ -3,8 +3,13 @@ class HelpController < ApplicationController

  layout 'help'

+  # Taken from Jekyll
+  # https://github.com/jekyll/jekyll/blob/3.5-stable/lib/jekyll/document.rb#L13
+  YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m
+
  def index
-    @help_index = File.read(Rails.root.join('doc', 'README.md'))
+    # 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
    # See http://rubular.com/r/X3baHTbPO2
@@ -22,7 +27,8 @@ class HelpController < ApplicationController
        path = File.join(Rails.root, 'doc', "#{@path}.md")

        if File.exist?(path)
-          @markdown = File.read(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