Help with index
This commit is contained in:
parent
69ec189ad2
commit
2be107d0d9
11 changed files with 444 additions and 426 deletions
|
@ -81,6 +81,8 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
&.nav-small-tabs > li > a { padding: 6px 9px; }
|
||||
}
|
||||
|
||||
/** ALERT MESSAGES **/
|
||||
|
|
34
app/views/help/_layout.html.haml
Normal file
34
app/views/help/_layout.html.haml
Normal file
|
@ -0,0 +1,34 @@
|
|||
.row
|
||||
.span3{:"data-spy" => 'affix'}
|
||||
.ui-box
|
||||
.title
|
||||
%h5 Help
|
||||
%ul.well-list
|
||||
%li
|
||||
%strong= link_to "Workflow", help_workflow_path
|
||||
%li
|
||||
%strong= link_to "SSH keys", help_ssh_path
|
||||
|
||||
%li
|
||||
%strong= link_to "GitLab Markdown", help_markdown_path
|
||||
|
||||
%li
|
||||
%strong= link_to "Permissions", help_permissions_path
|
||||
|
||||
%li
|
||||
%strong= link_to "API", help_api_path
|
||||
|
||||
%li
|
||||
%strong= link_to "Web Hooks", help_web_hooks_path
|
||||
|
||||
%li
|
||||
%strong= link_to "Rake Tasks", help_raketasks_path
|
||||
|
||||
%li
|
||||
%strong= link_to "System Hooks", help_system_hooks_path
|
||||
|
||||
%li
|
||||
%strong= link_to "Public Access", help_public_access_path
|
||||
|
||||
.span9.right
|
||||
= yield
|
|
@ -1,10 +1,8 @@
|
|||
%h3.page_title API
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%br
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title API
|
||||
%br
|
||||
|
||||
%ul.nav.nav-tabs.log-tabs
|
||||
%ul.nav.nav-tabs.log-tabs.nav-small-tabs
|
||||
%li.active
|
||||
= link_to "README", "#README", 'data-toggle' => 'tab'
|
||||
%li
|
||||
|
@ -24,7 +22,7 @@
|
|||
%li
|
||||
= link_to "Notes", "#notes", 'data-toggle' => 'tab'
|
||||
|
||||
.tab-content
|
||||
.tab-content
|
||||
.tab-pane.active#README
|
||||
.file_holder
|
||||
.file_title
|
||||
|
|
|
@ -1,10 +1,8 @@
|
|||
%h3.page_title GitLab Flavored Markdown
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title GitLab Flavored Markdown
|
||||
%br
|
||||
|
||||
.row
|
||||
.row
|
||||
.span8
|
||||
%p
|
||||
For GitLab we developed something we call "GitLab Flavored Markdown" (GFM).
|
||||
|
@ -27,7 +25,7 @@
|
|||
%strong= link_to "Markdown Syntax Guide", "http://daringfireball.net/projects/markdown/syntax"
|
||||
at Daring Fireball.
|
||||
|
||||
.row
|
||||
.row
|
||||
.span8
|
||||
%h3 Differences from traditional Markdown
|
||||
|
||||
|
@ -73,7 +71,7 @@
|
|||
|
||||
%h4 Emoji
|
||||
|
||||
.row
|
||||
.row
|
||||
.span8
|
||||
:ruby
|
||||
puts markdown %Q{Sometimes you want to be :cool: and add some :sparkles: to your :speech_balloon:. Well we have a :gift: for you:
|
||||
|
@ -92,7 +90,7 @@
|
|||
%strong= link_to "Emoji Cheat Sheet", "http://www.emoji-cheat-sheet.com/"
|
||||
for a list of all supported emoji codes.
|
||||
|
||||
.row
|
||||
.row
|
||||
.span8
|
||||
%h4 Special GitLab references
|
||||
|
||||
|
|
|
@ -1,17 +1,15 @@
|
|||
%h3.page_title Permissions
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title Permissions
|
||||
%br
|
||||
|
||||
%fieldset
|
||||
%fieldset
|
||||
%legend Guest
|
||||
%ul
|
||||
%li Create new issue
|
||||
%li Leave comments
|
||||
%li Write on project wall
|
||||
|
||||
%fieldset
|
||||
%fieldset
|
||||
%legend Reporter
|
||||
%ul
|
||||
%li Create new issue
|
||||
|
@ -22,7 +20,7 @@
|
|||
%li Create a code snippets
|
||||
|
||||
|
||||
%fieldset
|
||||
%fieldset
|
||||
%legend Developer
|
||||
%ul
|
||||
%li Create new issue
|
||||
|
@ -38,7 +36,7 @@
|
|||
%li Add tags
|
||||
%li Write a wiki
|
||||
|
||||
%fieldset
|
||||
%fieldset
|
||||
%legend Master
|
||||
%ul
|
||||
%li Create new issue
|
||||
|
@ -61,7 +59,7 @@
|
|||
%li Add Deploy Keys to project
|
||||
%li Configure Project Hooks
|
||||
|
||||
%fieldset
|
||||
%fieldset
|
||||
%legend Owner
|
||||
%ul
|
||||
%li Transfer project to another namespace
|
||||
|
|
|
@ -1,17 +1,15 @@
|
|||
%h3.page_title Public Access
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title Public Access
|
||||
%br
|
||||
|
||||
%p
|
||||
%p
|
||||
GitLab allows you to open selected projects to be accessed publicly.
|
||||
These projects will be clonable
|
||||
%em without any
|
||||
authentication.
|
||||
Also they will be listed on the #{link_to "public access directory", public_root_path}.
|
||||
|
||||
%ol
|
||||
%ol
|
||||
%li Go to your project dashboard
|
||||
%li Click on the "Edit" tab
|
||||
%li Select "Public clone access"
|
||||
|
|
|
@ -1,13 +1,11 @@
|
|||
%h3.page_title GitLab Rake Tasks
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title GitLab Rake Tasks
|
||||
%br
|
||||
|
||||
%p.slead
|
||||
%p.slead
|
||||
GitLab provides some specific rake tasks to enable special features or perform maintenance tasks.
|
||||
|
||||
%ul.nav.nav-tabs.log-tabs
|
||||
%ul.nav.nav-tabs.log-tabs
|
||||
%li.active
|
||||
= link_to "Features", "#features", 'data-toggle' => 'tab'
|
||||
%li
|
||||
|
@ -19,7 +17,7 @@
|
|||
%li
|
||||
= link_to "Cleanup", "#cleanup", 'data-toggle' => 'tab'
|
||||
|
||||
.tab-content
|
||||
.tab-content
|
||||
.tab-pane.active#features
|
||||
.file_holder
|
||||
.file_title
|
||||
|
|
|
@ -1,25 +1,23 @@
|
|||
%h3.page_title SSH Keys
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title SSH Keys
|
||||
%br
|
||||
|
||||
%p.slead
|
||||
%p.slead
|
||||
SSH key allows you to establish a secure connection between your computer and GitLab
|
||||
|
||||
%p.slead
|
||||
%p.slead
|
||||
To generate a new SSH key just open your terminal and use code below.
|
||||
|
||||
%pre.dark
|
||||
%pre.dark
|
||||
ssh-keygen -t rsa -C "#{current_user.email}"
|
||||
|
||||
\# Creates a new ssh key using the provided email
|
||||
\# Generating public/private rsa key pair...
|
||||
|
||||
%p.slead
|
||||
%p.slead
|
||||
Next just use code below to dump your public key and add to GitLab SSH Keys
|
||||
|
||||
%pre.dark
|
||||
%pre.dark
|
||||
cat ~/.ssh/id_rsa.pub
|
||||
|
||||
\# ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6eNtGpNGwstc....
|
||||
|
|
|
@ -1,14 +1,12 @@
|
|||
%h3 System hooks
|
||||
.back_link
|
||||
= link_to :back do
|
||||
← back
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title System hooks
|
||||
%br
|
||||
|
||||
%p.slead
|
||||
%p.slead
|
||||
Your GitLab instance can perform HTTP POST requests on the following events: create_project, delete_project, create_user, delete_user, change_team_member.
|
||||
%br
|
||||
%br
|
||||
System Hooks can be used, e.g. for logging or changing information in a LDAP server.
|
||||
%br
|
||||
%h5 Hooks request example:
|
||||
= render "admin/hooks/data_ex"
|
||||
%h5 Hooks request example:
|
||||
= render "admin/hooks/data_ex"
|
||||
|
|
|
@ -1,15 +1,13 @@
|
|||
%h3.page_title Web hooks
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title Web hooks
|
||||
%br
|
||||
|
||||
%p.slead
|
||||
%p.slead
|
||||
Every GitLab project can trigger a web server whenever the repo is pushed to.
|
||||
%br
|
||||
Web Hooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server.
|
||||
%br
|
||||
GitLab will send POST request with commits information on every push.
|
||||
%h5 Hooks request example:
|
||||
= render "hooks/data_ex"
|
||||
%h5 Hooks request example:
|
||||
= render "hooks/data_ex"
|
||||
|
||||
|
|
|
@ -1,10 +1,8 @@
|
|||
%h3.page_title Workflow
|
||||
.back_link
|
||||
= link_to help_path do
|
||||
← to index
|
||||
%hr
|
||||
= render layout: 'help/layout' do
|
||||
%h3.page_title Workflow
|
||||
%br
|
||||
|
||||
%ol.help
|
||||
%ol.help
|
||||
%li
|
||||
%p Clone project
|
||||
.bash
|
||||
|
|
Loading…
Reference in a new issue