Commit 03f741be42dab3bfc918b2394ea82593f4900cc6
Exists in
spb-stable
and in
3 other branches
Merge branch 'project-feature-doc' into 'master'
Add Project Features to doc/workflow Fixes #1123
Showing
3 changed files
with
38 additions
and
1 deletions
Show diff stats
doc/README.md
@@ -15,4 +15,4 @@ | @@ -15,4 +15,4 @@ | ||
15 | + [System hooks](system_hooks/system_hooks.md) | 15 | + [System hooks](system_hooks/system_hooks.md) |
16 | + [Update](update/README.md) | 16 | + [Update](update/README.md) |
17 | + [Web hooks](web_hooks/web_hooks.md) | 17 | + [Web hooks](web_hooks/web_hooks.md) |
18 | -+ [Workflow](workflow/workflow.md) | 18 | ++ [Workflow](workflow/README.md) |
@@ -0,0 +1,35 @@ | @@ -0,0 +1,35 @@ | ||
1 | +When in a Project -> Settings, you will find Features on the bottom of the page that you can toggle. | ||
2 | +Below you will find a more elaborate explanation of each of these. | ||
3 | + | ||
4 | + | ||
5 | +## Issues | ||
6 | + | ||
7 | +Issues is a really powerful, but lightweight issue tracking system. | ||
8 | +You can make tickets, assign them to people, file them under milestones, order them with labels and have discussion in them. | ||
9 | +They integrate deeply into GitLab and are easily referenced from anywhere by using # and the issuenumber. | ||
10 | +At GitLab.com, we use this for all our project management needs. | ||
11 | + | ||
12 | +## Merge Requests | ||
13 | + | ||
14 | +Using a merge request, you can review and discuss code before it is merged in the branch of your code. | ||
15 | +As with issues, it can be assigned; people, issues, etc. can be refereced; milestones attached. | ||
16 | +We see it as an integral part of working together on code and couldn't work without it. | ||
17 | + | ||
18 | + | ||
19 | +## Wiki | ||
20 | + | ||
21 | +This is a separate system for documentation, built right into GitLab. | ||
22 | +It is source controlled and is very convenient if you don't want to keep you documentation in your source code, but you do want to keep it in your GitLab project. | ||
23 | + | ||
24 | + | ||
25 | +## Wall | ||
26 | + | ||
27 | +For simple, project specific conversations, the wall can be used. | ||
28 | +It's very lightweight and simple and works well if you're not interested in using issues, but still want to occasionally communicate within a project. | ||
29 | + | ||
30 | + | ||
31 | +## Snippets | ||
32 | + | ||
33 | +Snippets are little bits of code or text. | ||
34 | +This is a nice place to put code or text that is used semi-regularly within the project, but does not belong in source control. | ||
35 | +For example, a specific config file that is used by > the team that is only valid for the people that work on the code. |