summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDouwe Maan <douwe@gitlab.com>2015-09-23 11:44:17 +0000
committerDouwe Maan <douwe@gitlab.com>2015-09-23 11:44:17 +0000
commitff63a166e9cbe9324d4be299cb87c26952efa67e (patch)
tree28bef1be6982a5424b6454d3476fca076a1ddc07
parente63b64de34a8f00fe1b77afe79dc240cdd654806 (diff)
parent95f73a68fa3ff235c35217b1c72666c5bad6ce03 (diff)
downloadgitlab-ce-ff63a166e9cbe9324d4be299cb87c26952efa67e.tar.gz
Merge branch 'rs-fix-help-links' into 'master'
Prevent double-prefixing of help page paths Closes #2679 See merge request !1400
-rw-r--r--app/controllers/help_controller.rb5
-rw-r--r--app/views/help/index.html.haml6
-rw-r--r--doc/README.md2
3 files changed, 7 insertions, 6 deletions
diff --git a/app/controllers/help_controller.rb b/app/controllers/help_controller.rb
index ad00948da51..55050615473 100644
--- a/app/controllers/help_controller.rb
+++ b/app/controllers/help_controller.rb
@@ -4,6 +4,11 @@ class HelpController < ApplicationController
layout 'help'
def index
+ @help_index = File.read(Rails.root.join('doc', 'README.md'))
+
+ # Prefix Markdown links with `help/` unless they already have been
+ # See http://rubular.com/r/nwwhzH6Z8X
+ @help_index.gsub!(/(\]\()(?!help\/)([^\)\(]+)(\))/, '\1help/\2\3')
end
def show
diff --git a/app/views/help/index.html.haml b/app/views/help/index.html.haml
index f492aaf4c0a..ab7ed1b5d95 100644
--- a/app/views/help/index.html.haml
+++ b/app/views/help/index.html.haml
@@ -27,11 +27,7 @@
.col-md-8
.documentation-index
= preserve do
- - readme_text = File.read(Rails.root.join("doc", "README.md"))
- - text = readme_text.dup
- - readme_text.scan(/\]\(([^(]+)\)/) { |match| text.gsub!(match.first, "help/#{match.first}") }
- = markdown text
-
+ = markdown(@help_index)
.col-md-4
.panel.panel-default
.panel-heading
diff --git a/doc/README.md b/doc/README.md
index 5f38086b8e3..a0ff856ebb6 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -51,7 +51,7 @@
### Administrator documentation
-+ [User permissions](permissions/README.md)
++ [User permissions](permissions/permissions.md)
+ [API](api/README.md)
## Contributor documentation