Help with index

This commit is contained in:
Dmitriy Zaporozhets 2013-01-22 17:58:09 +02:00
parent 69ec189ad2
commit 2be107d0d9
11 changed files with 444 additions and 426 deletions

View file

@ -81,6 +81,8 @@
} }
} }
} }
&.nav-small-tabs > li > a { padding: 6px 9px; }
} }
/** ALERT MESSAGES **/ /** ALERT MESSAGES **/

View 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

View file

@ -1,10 +1,8 @@
%h3.page_title API = render layout: 'help/layout' do
.back_link %h3.page_title API
= link_to help_path do %br
← to index
%br
%ul.nav.nav-tabs.log-tabs %ul.nav.nav-tabs.log-tabs.nav-small-tabs
%li.active %li.active
= link_to "README", "#README", 'data-toggle' => 'tab' = link_to "README", "#README", 'data-toggle' => 'tab'
%li %li
@ -24,7 +22,7 @@
%li %li
= link_to "Notes", "#notes", 'data-toggle' => 'tab' = link_to "Notes", "#notes", 'data-toggle' => 'tab'
.tab-content .tab-content
.tab-pane.active#README .tab-pane.active#README
.file_holder .file_holder
.file_title .file_title

View file

@ -1,10 +1,8 @@
%h3.page_title GitLab Flavored Markdown = render layout: 'help/layout' do
.back_link %h3.page_title GitLab Flavored Markdown
= link_to help_path do %br
← to index
%hr
.row .row
.span8 .span8
%p %p
For GitLab we developed something we call "GitLab Flavored Markdown" (GFM). 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" %strong= link_to "Markdown Syntax Guide", "http://daringfireball.net/projects/markdown/syntax"
at Daring Fireball. at Daring Fireball.
.row .row
.span8 .span8
%h3 Differences from traditional Markdown %h3 Differences from traditional Markdown
@ -73,7 +71,7 @@
%h4 Emoji %h4 Emoji
.row .row
.span8 .span8
:ruby :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: 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/" %strong= link_to "Emoji Cheat Sheet", "http://www.emoji-cheat-sheet.com/"
for a list of all supported emoji codes. for a list of all supported emoji codes.
.row .row
.span8 .span8
%h4 Special GitLab references %h4 Special GitLab references

View file

@ -1,17 +1,15 @@
%h3.page_title Permissions = render layout: 'help/layout' do
.back_link %h3.page_title Permissions
= link_to help_path do %br
← to index
%hr
%fieldset %fieldset
%legend Guest %legend Guest
%ul %ul
%li Create new issue %li Create new issue
%li Leave comments %li Leave comments
%li Write on project wall %li Write on project wall
%fieldset %fieldset
%legend Reporter %legend Reporter
%ul %ul
%li Create new issue %li Create new issue
@ -22,7 +20,7 @@
%li Create a code snippets %li Create a code snippets
%fieldset %fieldset
%legend Developer %legend Developer
%ul %ul
%li Create new issue %li Create new issue
@ -38,7 +36,7 @@
%li Add tags %li Add tags
%li Write a wiki %li Write a wiki
%fieldset %fieldset
%legend Master %legend Master
%ul %ul
%li Create new issue %li Create new issue
@ -61,7 +59,7 @@
%li Add Deploy Keys to project %li Add Deploy Keys to project
%li Configure Project Hooks %li Configure Project Hooks
%fieldset %fieldset
%legend Owner %legend Owner
%ul %ul
%li Transfer project to another namespace %li Transfer project to another namespace

View file

@ -1,17 +1,15 @@
%h3.page_title Public Access = render layout: 'help/layout' do
.back_link %h3.page_title Public Access
= link_to help_path do %br
← to index
%hr
%p %p
GitLab allows you to open selected projects to be accessed publicly. GitLab allows you to open selected projects to be accessed publicly.
These projects will be clonable These projects will be clonable
%em without any %em without any
authentication. authentication.
Also they will be listed on the #{link_to "public access directory", public_root_path}. Also they will be listed on the #{link_to "public access directory", public_root_path}.
%ol %ol
%li Go to your project dashboard %li Go to your project dashboard
%li Click on the "Edit" tab %li Click on the "Edit" tab
%li Select "Public clone access" %li Select "Public clone access"

View file

@ -1,13 +1,11 @@
%h3.page_title GitLab Rake Tasks = render layout: 'help/layout' do
.back_link %h3.page_title GitLab Rake Tasks
= link_to help_path do %br
← to index
%hr
%p.slead %p.slead
GitLab provides some specific rake tasks to enable special features or perform maintenance tasks. 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 %li.active
= link_to "Features", "#features", 'data-toggle' => 'tab' = link_to "Features", "#features", 'data-toggle' => 'tab'
%li %li
@ -19,7 +17,7 @@
%li %li
= link_to "Cleanup", "#cleanup", 'data-toggle' => 'tab' = link_to "Cleanup", "#cleanup", 'data-toggle' => 'tab'
.tab-content .tab-content
.tab-pane.active#features .tab-pane.active#features
.file_holder .file_holder
.file_title .file_title

View file

@ -1,25 +1,23 @@
%h3.page_title SSH Keys = render layout: 'help/layout' do
.back_link %h3.page_title SSH Keys
= link_to help_path do %br
← to index
%hr
%p.slead %p.slead
SSH key allows you to establish a secure connection between your computer and GitLab 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. 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}" ssh-keygen -t rsa -C "#{current_user.email}"
\# Creates a new ssh key using the provided email \# Creates a new ssh key using the provided email
\# Generating public/private rsa key pair... \# 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 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 cat ~/.ssh/id_rsa.pub
\# ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6eNtGpNGwstc.... \# ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6eNtGpNGwstc....

View file

@ -1,14 +1,12 @@
%h3 System hooks = render layout: 'help/layout' do
.back_link %h3.page_title System hooks
= link_to :back do %br
← back
%hr
%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. 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
%br %br
System Hooks can be used, e.g. for logging or changing information in a LDAP server. System Hooks can be used, e.g. for logging or changing information in a LDAP server.
%br %br
%h5 Hooks request example: %h5 Hooks request example:
= render "admin/hooks/data_ex" = render "admin/hooks/data_ex"

View file

@ -1,15 +1,13 @@
%h3.page_title Web hooks = render layout: 'help/layout' do
.back_link %h3.page_title Web hooks
= link_to help_path do %br
← to index
%hr
%p.slead %p.slead
Every GitLab project can trigger a web server whenever the repo is pushed to. Every GitLab project can trigger a web server whenever the repo is pushed to.
%br %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. 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 %br
GitLab will send POST request with commits information on every push. GitLab will send POST request with commits information on every push.
%h5 Hooks request example: %h5 Hooks request example:
= render "hooks/data_ex" = render "hooks/data_ex"

View file

@ -1,10 +1,8 @@
%h3.page_title Workflow = render layout: 'help/layout' do
.back_link %h3.page_title Workflow
= link_to help_path do %br
← to index
%hr
%ol.help %ol.help
%li %li
%p Clone project %p Clone project
.bash .bash