BigW Consortium Gitlab
Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
G
gitlab-ce
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Forest Godfrey
gitlab-ce
Commits
ef47ea3d
Commit
ef47ea3d
authored
Apr 15, 2015
by
Robert Speicher
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Revert "Fix and improve help rendering"
This reverts commit
d365004e
.
parent
5f78601c
Hide whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
30 additions
and
47 deletions
+30
-47
help_controller.rb
app/controllers/help_controller.rb
+7
-23
show.html.haml
app/views/help/show.html.haml
+1
-1
mime_types.rb
config/initializers/mime_types.rb
+0
-1
routes.rb
config/routes.rb
+1
-1
help.rb
features/steps/dashboard/help.rb
+1
-1
help_pages_spec.rb
spec/features/help_pages_spec.rb
+1
-1
routing_spec.rb
spec/routing/routing_spec.rb
+19
-19
No files found.
app/controllers/help_controller.rb
View file @
ef47ea3d
...
...
@@ -3,40 +3,24 @@ class HelpController < ApplicationController
end
def
show
@
filepath
=
clean_path_info
(
params
[
:filepath
])
@f
ormat
=
params
[
:format
]
@
category
=
clean_path_info
(
params
[
:category
])
@f
ile
=
clean_path_info
(
params
[
:file
])
respond_to
do
|
format
|
format
.
md
{
render_doc
}
format
.
all
{
send_file_data
}
end
end
def
shortcuts
end
private
def
render_doc
if
File
.
exists?
(
Rails
.
root
.
join
(
'doc'
,
@filepath
+
'.md'
))
render
'show.html.haml'
if
File
.
exists?
(
Rails
.
root
.
join
(
'doc'
,
@category
,
@file
+
'.md'
))
render
'show'
else
not_found!
end
end
def
send_file_data
path
=
Rails
.
root
.
join
(
'doc'
,
"
#{
@filepath
}
.
#{
@format
}
"
)
if
File
.
exists?
(
path
)
send_file
(
path
,
disposition:
'inline'
)
else
head
:not_found
end
def
shortcuts
end
def
ui
end
private
PATH_SEPS
=
Regexp
.
union
(
*
[
::
File
::
SEPARATOR
,
::
File
::
ALT_SEPARATOR
].
compact
)
# Taken from ActionDispatch::FileHandler
...
...
app/views/help/show.html.haml
View file @
ef47ea3d
.documentation.wiki
=
markdown
File
.
read
(
Rails
.
root
.
join
(
'doc'
,
@
filepath
+
'.md'
)).
gsub
(
"$your_email"
,
current_user
.
email
)
=
markdown
File
.
read
(
Rails
.
root
.
join
(
'doc'
,
@
category
,
@file
+
'.md'
)).
gsub
(
"$your_email"
,
current_user
.
email
)
config/initializers/mime_types.rb
View file @
ef47ea3d
...
...
@@ -6,4 +6,3 @@
Mime
::
Type
.
register_alias
"text/plain"
,
:diff
Mime
::
Type
.
register_alias
"text/plain"
,
:patch
Mime
::
Type
.
register_alias
'text/html'
,
:md
config/routes.rb
View file @
ef47ea3d
...
...
@@ -39,9 +39,9 @@ Gitlab::Application.routes.draw do
# Help
get
'help'
=>
'help#index'
get
'help/:category/:file'
=>
'help#show'
,
as: :help_page
get
'help/shortcuts'
get
'help/ui'
=>
'help#ui'
get
'help/:filepath'
=>
'help#show'
,
as: :help_page
,
constraints:
{
filepath:
/[^\.]+/
}
#
# Global snippets
...
...
features/steps/dashboard/help.rb
View file @
ef47ea3d
...
...
@@ -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'
,
format:
'md'
)
visit
help_page_path
(
"raketasks"
,
"maintenance"
)
end
step
'I should see "Rake Tasks" page markdown rendered'
do
...
...
spec/features/help_pages_spec.rb
View file @
ef47ea3d
...
...
@@ -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
(
filepath:
'ssh/README'
,
format:
'
md'
)
visit
help_page_path
(
category:
'ssh'
,
file:
'README.
md'
)
expect
(
page
).
to
have_content
(
"ssh-keygen -t rsa -C
\"
#{
@user
.
email
}
\"
"
)
end
end
...
...
spec/routing/routing_spec.rb
View file @
ef47ea3d
...
...
@@ -73,41 +73,41 @@ end
# help_markdown GET /help/markdown(.:format) help#markdown
# help_ssh GET /help/ssh(.:format) help#ssh
# help_raketasks GET /help/raketasks(.:format) help#raketasks
describe
HelpController
,
'routing'
do
it
'to #index'
do
expect
(
get
(
'/help'
)).
to
route_to
(
'help#index'
)
describe
HelpController
,
"routing"
do
it
"to #index"
do
expect
(
get
(
"/help"
)).
to
route_to
(
'help#index'
)
end
it
'to #permissions'
do
expect
(
get
(
'/help/permissions/permissions'
)).
to
route_to
(
'help#show'
,
filepath:
'permissions/permissions'
)
it
"to #permissions"
do
expect
(
get
(
"/help/permissions/permissions"
)).
to
route_to
(
'help#show'
,
category:
"permissions"
,
file:
"permissions"
)
end
it
'to #workflow'
do
expect
(
get
(
'/help/workflow/README'
)).
to
route_to
(
'help#show'
,
filepath:
'workflow/README'
)
it
"to #workflow"
do
expect
(
get
(
"/help/workflow/README"
)).
to
route_to
(
'help#show'
,
category:
"workflow"
,
file:
"README"
)
end
it
'to #api'
do
expect
(
get
(
'/help/api/README'
)).
to
route_to
(
'help#show'
,
filepath:
'api/README'
)
it
"to #api"
do
expect
(
get
(
"/help/api/README"
)).
to
route_to
(
'help#show'
,
category:
"api"
,
file:
"README"
)
end
it
'to #web_hooks'
do
expect
(
get
(
'/help/web_hooks/web_hooks'
)).
to
route_to
(
'help#show'
,
filepath:
'web_hooks/web_hooks'
)
it
"to #web_hooks"
do
expect
(
get
(
"/help/web_hooks/web_hooks"
)).
to
route_to
(
'help#show'
,
category:
"web_hooks"
,
file:
"web_hooks"
)
end
it
'to #system_hooks'
do
expect
(
get
(
'/help/system_hooks/system_hooks'
)).
to
route_to
(
'help#show'
,
filepath:
'system_hooks/system_hooks'
)
it
"to #system_hooks"
do
expect
(
get
(
"/help/system_hooks/system_hooks"
)).
to
route_to
(
'help#show'
,
category:
"system_hooks"
,
file:
"system_hooks"
)
end
it
'to #markdown'
do
expect
(
get
(
'/help/markdown/markdown'
)).
to
route_to
(
'help#show'
,
filepath:
'markdown/markdown'
)
it
"to #markdown"
do
expect
(
get
(
"/help/markdown/markdown"
)).
to
route_to
(
'help#show'
,
category:
"markdown"
,
file:
"markdown"
)
end
it
'to #ssh'
do
expect
(
get
(
'/help/ssh/README'
)).
to
route_to
(
'help#show'
,
filepath:
'ssh/README'
)
it
"to #ssh"
do
expect
(
get
(
"/help/ssh/README"
)).
to
route_to
(
'help#show'
,
category:
"ssh"
,
file:
"README"
)
end
it
'to #raketasks'
do
expect
(
get
(
'/help/raketasks/README'
)).
to
route_to
(
'help#show'
,
filepath:
'raketasks/README'
)
it
"to #raketasks"
do
expect
(
get
(
"/help/raketasks/README"
)).
to
route_to
(
'help#show'
,
category:
"raketasks"
,
file:
"README"
)
end
end
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment