diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-03-22 11:21:48 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-03-22 11:21:48 +0000 |
commit | d0898fa243a77221dd0b2a80dd919c977619ca5d (patch) | |
tree | 36f6825ed538578a2ee808b36115b96a94b3d990 /doc | |
parent | fc6ee359287c6bd286e32ce808e7069714e1732e (diff) | |
parent | 09cd4351fa17ffcae3b5ce960e562a7ced6facfe (diff) | |
download | gitlab-ce-d0898fa243a77221dd0b2a80dd919c977619ca5d.tar.gz |
Merge branch 'gitlab_intro_docs' into 'master'
GitLab intro docs
Related to https://gitlab.com/gitlab-org/marketing_monthly_release/issues/1
---
Need refactor:
- Create a new project
- Create a new group
- Create a new issue
- Assign labels to issues
- Use milestones as an overview of your project's tracker
- Fork a project and contribute to it
- Create a new merge request
- Automatically close issues from merge requests (include GitLab.com pattern)
- GitLab CI quick start guide (make it easier to follow)
Moved to https://gitlab.com/gitlab-org/gitlab-ce/issues/8068
See merge request !3225
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gitlab-basics/README.md | 34 | ||||
-rw-r--r-- | doc/gitlab-basics/basic-git-commands.md | 58 | ||||
-rw-r--r-- | doc/gitlab-basics/start-using-git.md | 63 | ||||
-rw-r--r-- | doc/intro/README.md | 41 | ||||
-rw-r--r-- | doc/workflow/award_emoji.md | 48 | ||||
-rw-r--r-- | doc/workflow/img/award_emoji_select.png | bin | 0 -> 65985 bytes | |||
-rw-r--r-- | doc/workflow/img/award_emoji_votes_least_popular.png | bin | 0 -> 144501 bytes | |||
-rw-r--r-- | doc/workflow/img/award_emoji_votes_most_popular.png | bin | 0 -> 136577 bytes | |||
-rw-r--r-- | doc/workflow/img/award_emoji_votes_sort_options.png | bin | 0 -> 162251 bytes |
9 files changed, 163 insertions, 81 deletions
diff --git a/doc/gitlab-basics/README.md b/doc/gitlab-basics/README.md index 493e1d1b09c..3aa83975ace 100644 --- a/doc/gitlab-basics/README.md +++ b/doc/gitlab-basics/README.md @@ -2,26 +2,14 @@ Step-by-step guides on the basics of working with Git and GitLab. -* [Start using Git on the command line](start-using-git.md) - -* [Create and add your SSH Keys](create-your-ssh-keys.md) - -* [Command Line basic commands](command-line-commands.md) - -* [Basic Git commands](basic-git-commands.md) - -* [Create a project](create-project.md) - -* [Create a group](create-group.md) - -* [Create a branch](create-branch.md) - -* [Fork a project](fork-project.md) - -* [Add a file](add-file.md) - -* [Add an image](add-image.md) - -* [Create a Merge Request](add-merge-request.md) - -* [Create an Issue](create-issue.md) +- [Start using Git on the command line](start-using-git.md) +- [Create and add your SSH Keys](create-your-ssh-keys.md) +- [Command Line basics](command-line-commands.md) +- [Create a project](create-project.md) +- [Create a group](create-group.md) +- [Create a branch](create-branch.md) +- [Fork a project](fork-project.md) +- [Add a file](add-file.md) +- [Add an image](add-image.md) +- [Create a Merge Request](add-merge-request.md) +- [Create an Issue](create-issue.md) diff --git a/doc/gitlab-basics/basic-git-commands.md b/doc/gitlab-basics/basic-git-commands.md index 2b5767dd2d3..c2a3415cbc4 100644 --- a/doc/gitlab-basics/basic-git-commands.md +++ b/doc/gitlab-basics/basic-git-commands.md @@ -1,59 +1,3 @@ # Basic Git commands -### Go to the master branch to pull the latest changes from there -``` -git checkout master -``` - -### Download the latest changes in the project -This is for you to work on an up-to-date copy (it is important to do every time you work on a project), while you setup tracking branches. -``` -git pull REMOTE NAME-OF-BRANCH -u -``` -(REMOTE: origin) (NAME-OF-BRANCH: could be "master" or an existing branch) - -### Create a branch -Spaces won't be recognized, so you need to use a hyphen or underscore. -``` -git checkout -b NAME-OF-BRANCH -``` - -### Work on a branch that has already been created -``` -git checkout NAME-OF-BRANCH -``` - -### View the changes you've made -It's important to be aware of what's happening and what's the status of your changes. -``` -git status -``` - -### Add changes to commit -You'll see your changes in red when you type "git status". -``` -git add CHANGES IN RED -git commit -m "DESCRIBE THE INTENTION OF THE COMMIT" -``` - -### Send changes to gitlab.com -``` -git push REMOTE NAME-OF-BRANCH -``` - -### Delete all changes in the Git repository, but leave unstaged things -``` -git checkout . -``` - -### Delete all changes in the Git repository, including untracked files -``` -git clean -f -``` - -### Merge created branch with master branch -You need to be in the created branch. -``` -git checkout NAME-OF-BRANCH -git merge master -``` +This section is now merged into [Start using Git](start-using-git.md). diff --git a/doc/gitlab-basics/start-using-git.md b/doc/gitlab-basics/start-using-git.md index b2ceda025c0..89ce8bcc3e8 100644 --- a/doc/gitlab-basics/start-using-git.md +++ b/doc/gitlab-basics/start-using-git.md @@ -1,6 +1,7 @@ # Start using Git on the command line -If you want to start using a Git and GitLab, make sure that you have created an account on GitLab. +If you want to start using a Git and GitLab, make sure that you have created an +account on GitLab. ## Open a shell @@ -59,3 +60,63 @@ To view the information that you entered, type: ``` git config --global --list ``` +## Basic Git commands + +### Go to the master branch to pull the latest changes from there + +``` +git checkout master +``` + +### Download the latest changes in the project +This is for you to work on an up-to-date copy (it is important to do every time you work on a project), while you setup tracking branches. +``` +git pull REMOTE NAME-OF-BRANCH -u +``` +(REMOTE: origin) (NAME-OF-BRANCH: could be "master" or an existing branch) + +### Create a branch +Spaces won't be recognized, so you need to use a hyphen or underscore. +``` +git checkout -b NAME-OF-BRANCH +``` + +### Work on a branch that has already been created +``` +git checkout NAME-OF-BRANCH +``` + +### View the changes you've made +It's important to be aware of what's happening and what's the status of your changes. +``` +git status +``` + +### Add changes to commit +You'll see your changes in red when you type "git status". +``` +git add CHANGES IN RED +git commit -m "DESCRIBE THE INTENTION OF THE COMMIT" +``` + +### Send changes to gitlab.com +``` +git push REMOTE NAME-OF-BRANCH +``` + +### Delete all changes in the Git repository, but leave unstaged things +``` +git checkout . +``` + +### Delete all changes in the Git repository, including untracked files +``` +git clean -f +``` + +### Merge created branch with master branch +You need to be in the created branch. +``` +git checkout NAME-OF-BRANCH +git merge master +``` diff --git a/doc/intro/README.md b/doc/intro/README.md new file mode 100644 index 00000000000..fecbbe6317b --- /dev/null +++ b/doc/intro/README.md @@ -0,0 +1,41 @@ +# Get started with GitLab + +## Organize + +Create projects and groups. + +- [Create a new project](../gitlab-basics/create-project.md) +- [Create a new group](../gitlab-basics/create-group.md) + +## Prioritize + +Create issues, labels, milestones, cast your vote, and review issues. + +- [Create a new issue](../gitlab-basics/create-issue.md) +- [Assign labels to issues](../workflow/labels.md) +- [Use milestones as an overview of your project's tracker](../workflow/milestones.md) +- [Use voting to express your like/dislike to issues and merge requests](../workflow/award_emoji.md) + +## Collaborate + +Create merge requests and review code. + +- [Fork a project and contribute to it](../workflow/forking_workflow.md) +- [Create a new merge request](../gitlab-basics/add-merge-request.md) +- [Automatically close issues from merge requests](../customization/issue_closing.md) +- [Automatically merge when your builds succeed](../workflow/merge_when_build_succeeds.md) +- [Revert any commit](../workflow/revert_changes.md) + +## Test and Deploy + +Use the built-in continuous integration in GitLab. + +- [Get started with GitLab CI](../ci/quick_start/README.md) + +## Install and Update + +Install and update your GitLab installation. + +- [Install GitLab](https://about.gitlab.com/installation/) +- [Update GitLab](https://about.gitlab.com/update/) +- [Explore Omnibus GitLab configuration options](http://doc.gitlab.com/omnibus/settings/configuration.html) diff --git a/doc/workflow/award_emoji.md b/doc/workflow/award_emoji.md new file mode 100644 index 00000000000..70b35c58be6 --- /dev/null +++ b/doc/workflow/award_emoji.md @@ -0,0 +1,48 @@ +# Award emojis + +>**Note:** +This feature was [introduced][1825] in GitLab 8.2. + +When you're collaborating online, you get fewer opportunities for high-fives +and thumbs-ups. In order to make virtual celebrations easier, you can now vote +on issues and merge requests using emoji! + +![Award emoji](img/award_emoji_select.png) + +This makes it much easier to give and receive feedback, without a long comment +thread. Any comment that contains only the thumbs up or down emojis is +converted to a vote and depicted in the emoji area. + +You can then use that functionality to sort issues and merge requests based on +popularity. + +## Sort issues and merge requests on vote count + +>**Note:** +This feature was [introduced][2871] in GitLab 8.5. + +You can quickly sort the issues or merge requests by the number of votes they +have received. The sort option can be found in the right dropdown menu. + +![Votes sort options](img/award_emoji_votes_sort_options.png) + +--- + +Sort by most popular issues/merge requests. + +![Votes sort by most popular](img/award_emoji_votes_most_popular.png) + +--- + +Sort by least popular issues/merge requests. + +![Votes sort by least popular](img/award_emoji_votes_least_popular.png) + +--- + +The number of upvotes and downvotes is not summed up. That means that an issue +with 18 upvotes and 5 downvotes is considered more popular than an issue with +17 upvotes and no downvotes. + +[2871]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2781 +[1825]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/1825 diff --git a/doc/workflow/img/award_emoji_select.png b/doc/workflow/img/award_emoji_select.png Binary files differnew file mode 100644 index 00000000000..fffdfedda5d --- /dev/null +++ b/doc/workflow/img/award_emoji_select.png diff --git a/doc/workflow/img/award_emoji_votes_least_popular.png b/doc/workflow/img/award_emoji_votes_least_popular.png Binary files differnew file mode 100644 index 00000000000..2ef5be7154f --- /dev/null +++ b/doc/workflow/img/award_emoji_votes_least_popular.png diff --git a/doc/workflow/img/award_emoji_votes_most_popular.png b/doc/workflow/img/award_emoji_votes_most_popular.png Binary files differnew file mode 100644 index 00000000000..5b089730d93 --- /dev/null +++ b/doc/workflow/img/award_emoji_votes_most_popular.png diff --git a/doc/workflow/img/award_emoji_votes_sort_options.png b/doc/workflow/img/award_emoji_votes_sort_options.png Binary files differnew file mode 100644 index 00000000000..9bbf3f82a0b --- /dev/null +++ b/doc/workflow/img/award_emoji_votes_sort_options.png |