diff options
Diffstat (limited to 'doc/user/gitlab-basics')
57 files changed, 536 insertions, 0 deletions
diff --git a/doc/user/gitlab-basics/README.md b/doc/user/gitlab-basics/README.md new file mode 100644 index 00000000000..3aa83975ace --- /dev/null +++ b/doc/user/gitlab-basics/README.md @@ -0,0 +1,15 @@ +# GitLab basics + +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 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/user/gitlab-basics/add-file.md b/doc/user/gitlab-basics/add-file.md new file mode 100644 index 00000000000..57136ac5c39 --- /dev/null +++ b/doc/user/gitlab-basics/add-file.md @@ -0,0 +1,31 @@ +# How to add a file + +You can create a file in your [shell](command-line-commands.md) or in GitLab. + +To create a file in GitLab, sign in to GitLab. + +Select a project on the right side of your screen: + + + +It's a good idea to [create a branch](create-branch.md), but it's not necessary. + +Go to the directory where you'd like to add the file and click on the "+" sign next to the name of the project and directory: + + + +Name your file (you can't add spaces, so you can use hyphens or underscores). Don't forget to include the markup language you'd like to use : + + + +Add all the information that you'd like to include in your file: + + + +Add a commit message based on what you just added and then click on "commit changes": + + + +### Note +Besides its regular files, every directory needs a README.md or README.html file which works like an index, telling +what the directory is about. It's the first document you'll find when you open a directory. diff --git a/doc/user/gitlab-basics/add-image.md b/doc/user/gitlab-basics/add-image.md new file mode 100644 index 00000000000..476b48a217c --- /dev/null +++ b/doc/user/gitlab-basics/add-image.md @@ -0,0 +1,62 @@ +# How to add an image + +The following are the steps to add images to your repository in +GitLab: + +Find the image that you’d like to add. + +In your computer files, find the GitLab project to which you'd like to add the image +(you'll find it as a regular file). Click on every file until you find exactly where you'd +like to add the image. There, paste the image. + +Go to your [shell](command-line-commands.md), and add the following commands: + +Add this command for every directory that you'd like to open: +``` +cd NAME-OF-FILE-YOU'D-LIKE-TO-OPEN +``` + +Create a new branch: +``` +git checkout -b NAME-OF-BRANCH +``` + +Check if your image was correctly added to the directory: +``` +ls +``` + +You should see the name of the image in the list shown. + +Move up the hierarchy through directories: +``` +cd ../ +``` + +Check the status and you should see your image’s name in red: +``` +git status +``` + +Add your changes: +``` +git add NAME-OF-YOUR-IMAGE +``` + +Check the status and you should see your image’s name in green: +``` +git status +``` + +Add the commit: +``` +git commit -m “DESCRIBE COMMIT IN A FEW WORDS” +``` + +Now you can push (send) your changes (in the branch NAME-OF-BRANCH) to GitLab (the git remote named 'origin'): +``` +git push origin NAME-OF-BRANCH +``` + +Your image will be added to your branch in your repository in GitLab. Create a [Merge Request](add-merge-request.md) +to integrate your changes to your project. diff --git a/doc/user/gitlab-basics/add-merge-request.md b/doc/user/gitlab-basics/add-merge-request.md new file mode 100644 index 00000000000..236b4248ea2 --- /dev/null +++ b/doc/user/gitlab-basics/add-merge-request.md @@ -0,0 +1,42 @@ +# How to create a merge request + +Merge Requests are useful to integrate separate changes that you've made to a project, on different branches. + +To create a new Merge Request, sign in to GitLab. + +Go to the project where you'd like to merge your changes: + + + +Click on "Merge Requests" on the left side of your screen: + + + +Click on "+ new Merge Request" on the right side of the screen: + + + +Select a source branch or branch: + + + +Click on the "compare branches" button: + + + +Add a title and a description to your Merge Request: + + + +Select a user to review your Merge Request and to accept or close it. You may also select milestones and labels (they are optional). Then click on the "submit new Merge Request" button: + + + +Your Merge Request will be ready to be approved and published. + +### Note + +After you created a new branch, you'll immediately find a "create a Merge Request" button at the top of your screen. +You may automatically create a Merge Request from your recently created branch when clicking on this button: + + diff --git a/doc/user/gitlab-basics/basic-git-commands.md b/doc/user/gitlab-basics/basic-git-commands.md new file mode 100644 index 00000000000..c2a3415cbc4 --- /dev/null +++ b/doc/user/gitlab-basics/basic-git-commands.md @@ -0,0 +1,3 @@ +# Basic Git commands + +This section is now merged into [Start using Git](start-using-git.md). diff --git a/doc/user/gitlab-basics/basicsimages/add_new_merge_request.png b/doc/user/gitlab-basics/basicsimages/add_new_merge_request.png Binary files differnew file mode 100644 index 00000000000..9d93b217a59 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/add_new_merge_request.png diff --git a/doc/user/gitlab-basics/basicsimages/add_sshkey.png b/doc/user/gitlab-basics/basicsimages/add_sshkey.png Binary files differnew file mode 100644 index 00000000000..2dede97aa40 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/add_sshkey.png diff --git a/doc/user/gitlab-basics/basicsimages/branch_info.png b/doc/user/gitlab-basics/basicsimages/branch_info.png Binary files differnew file mode 100644 index 00000000000..c5e38b552a5 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/branch_info.png diff --git a/doc/user/gitlab-basics/basicsimages/branch_name.png b/doc/user/gitlab-basics/basicsimages/branch_name.png Binary files differnew file mode 100644 index 00000000000..06e77f5eea9 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/branch_name.png diff --git a/doc/user/gitlab-basics/basicsimages/branches.png b/doc/user/gitlab-basics/basicsimages/branches.png Binary files differnew file mode 100644 index 00000000000..c18fa83b968 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/branches.png diff --git a/doc/user/gitlab-basics/basicsimages/button-create-mr.png b/doc/user/gitlab-basics/basicsimages/button-create-mr.png Binary files differnew file mode 100644 index 00000000000..457af459bb9 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/button-create-mr.png diff --git a/doc/user/gitlab-basics/basicsimages/click-on-new-group.png b/doc/user/gitlab-basics/basicsimages/click-on-new-group.png Binary files differnew file mode 100644 index 00000000000..94b6d5756d3 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/click-on-new-group.png diff --git a/doc/user/gitlab-basics/basicsimages/commit_changes.png b/doc/user/gitlab-basics/basicsimages/commit_changes.png Binary files differnew file mode 100644 index 00000000000..81588336f37 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/commit_changes.png diff --git a/doc/user/gitlab-basics/basicsimages/commit_message.png b/doc/user/gitlab-basics/basicsimages/commit_message.png Binary files differnew file mode 100644 index 00000000000..0df2c32653c --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/commit_message.png diff --git a/doc/user/gitlab-basics/basicsimages/commits.png b/doc/user/gitlab-basics/basicsimages/commits.png Binary files differnew file mode 100644 index 00000000000..7e606539077 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/commits.png diff --git a/doc/user/gitlab-basics/basicsimages/compare_branches.png b/doc/user/gitlab-basics/basicsimages/compare_branches.png Binary files differnew file mode 100644 index 00000000000..7eebaed9075 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/compare_branches.png diff --git a/doc/user/gitlab-basics/basicsimages/create_file.png b/doc/user/gitlab-basics/basicsimages/create_file.png Binary files differnew file mode 100644 index 00000000000..688e355cca2 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/create_file.png diff --git a/doc/user/gitlab-basics/basicsimages/create_group.png b/doc/user/gitlab-basics/basicsimages/create_group.png Binary files differnew file mode 100644 index 00000000000..57da898abdc --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/create_group.png diff --git a/doc/user/gitlab-basics/basicsimages/edit_file.png b/doc/user/gitlab-basics/basicsimages/edit_file.png Binary files differnew file mode 100644 index 00000000000..afa68760108 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/edit_file.png diff --git a/doc/user/gitlab-basics/basicsimages/file_located.png b/doc/user/gitlab-basics/basicsimages/file_located.png Binary files differnew file mode 100644 index 00000000000..1def489d16b --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/file_located.png diff --git a/doc/user/gitlab-basics/basicsimages/file_name.png b/doc/user/gitlab-basics/basicsimages/file_name.png Binary files differnew file mode 100644 index 00000000000..9ac2f1c355f --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/file_name.png diff --git a/doc/user/gitlab-basics/basicsimages/find_file.png b/doc/user/gitlab-basics/basicsimages/find_file.png Binary files differnew file mode 100644 index 00000000000..98639149a39 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/find_file.png diff --git a/doc/user/gitlab-basics/basicsimages/find_group.png b/doc/user/gitlab-basics/basicsimages/find_group.png Binary files differnew file mode 100644 index 00000000000..5ac33c7e953 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/find_group.png diff --git a/doc/user/gitlab-basics/basicsimages/fork.png b/doc/user/gitlab-basics/basicsimages/fork.png Binary files differnew file mode 100644 index 00000000000..b1f94938613 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/fork.png diff --git a/doc/user/gitlab-basics/basicsimages/group_info.png b/doc/user/gitlab-basics/basicsimages/group_info.png Binary files differnew file mode 100644 index 00000000000..e78d84e4d80 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/group_info.png diff --git a/doc/user/gitlab-basics/basicsimages/groups.png b/doc/user/gitlab-basics/basicsimages/groups.png Binary files differnew file mode 100644 index 00000000000..b8104343afa --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/groups.png diff --git a/doc/user/gitlab-basics/basicsimages/https.png b/doc/user/gitlab-basics/basicsimages/https.png Binary files differnew file mode 100644 index 00000000000..2a31b4cf751 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/https.png diff --git a/doc/user/gitlab-basics/basicsimages/image_file.png b/doc/user/gitlab-basics/basicsimages/image_file.png Binary files differnew file mode 100644 index 00000000000..1061d9c5082 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/image_file.png diff --git a/doc/user/gitlab-basics/basicsimages/issue_title.png b/doc/user/gitlab-basics/basicsimages/issue_title.png Binary files differnew file mode 100644 index 00000000000..7b69c705392 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/issue_title.png diff --git a/doc/user/gitlab-basics/basicsimages/issues.png b/doc/user/gitlab-basics/basicsimages/issues.png Binary files differnew file mode 100644 index 00000000000..9354d05319e --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/issues.png diff --git a/doc/user/gitlab-basics/basicsimages/key.png b/doc/user/gitlab-basics/basicsimages/key.png Binary files differnew file mode 100644 index 00000000000..321805cda98 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/key.png diff --git a/doc/user/gitlab-basics/basicsimages/merge_requests.png b/doc/user/gitlab-basics/basicsimages/merge_requests.png Binary files differnew file mode 100644 index 00000000000..7601d40de47 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/merge_requests.png diff --git a/doc/user/gitlab-basics/basicsimages/new_issue.png b/doc/user/gitlab-basics/basicsimages/new_issue.png Binary files differnew file mode 100644 index 00000000000..94e7503dd8b --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/new_issue.png diff --git a/doc/user/gitlab-basics/basicsimages/new_merge_request.png b/doc/user/gitlab-basics/basicsimages/new_merge_request.png Binary files differnew file mode 100644 index 00000000000..9120d2b1ab1 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/new_merge_request.png diff --git a/doc/user/gitlab-basics/basicsimages/new_project.png b/doc/user/gitlab-basics/basicsimages/new_project.png Binary files differnew file mode 100644 index 00000000000..ac255270a66 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/new_project.png diff --git a/doc/user/gitlab-basics/basicsimages/newbranch.png b/doc/user/gitlab-basics/basicsimages/newbranch.png Binary files differnew file mode 100644 index 00000000000..da1a6b604ea --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/newbranch.png diff --git a/doc/user/gitlab-basics/basicsimages/paste_sshkey.png b/doc/user/gitlab-basics/basicsimages/paste_sshkey.png Binary files differnew file mode 100644 index 00000000000..9880ddfead1 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/paste_sshkey.png diff --git a/doc/user/gitlab-basics/basicsimages/profile_settings.png b/doc/user/gitlab-basics/basicsimages/profile_settings.png Binary files differnew file mode 100644 index 00000000000..5f2e7a7e10c --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/profile_settings.png diff --git a/doc/user/gitlab-basics/basicsimages/project_info.png b/doc/user/gitlab-basics/basicsimages/project_info.png Binary files differnew file mode 100644 index 00000000000..6c06ff351fa --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/project_info.png diff --git a/doc/user/gitlab-basics/basicsimages/public_file_link.png b/doc/user/gitlab-basics/basicsimages/public_file_link.png Binary files differnew file mode 100644 index 00000000000..1a60a3d880a --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/public_file_link.png diff --git a/doc/user/gitlab-basics/basicsimages/select-group.png b/doc/user/gitlab-basics/basicsimages/select-group.png Binary files differnew file mode 100644 index 00000000000..d02c2255ff2 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/select-group.png diff --git a/doc/user/gitlab-basics/basicsimages/select-group2.png b/doc/user/gitlab-basics/basicsimages/select-group2.png Binary files differnew file mode 100644 index 00000000000..fd40bce499b --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/select-group2.png diff --git a/doc/user/gitlab-basics/basicsimages/select_branch.png b/doc/user/gitlab-basics/basicsimages/select_branch.png Binary files differnew file mode 100644 index 00000000000..3475b2df576 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/select_branch.png diff --git a/doc/user/gitlab-basics/basicsimages/select_project.png b/doc/user/gitlab-basics/basicsimages/select_project.png Binary files differnew file mode 100644 index 00000000000..6d5aa439124 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/select_project.png diff --git a/doc/user/gitlab-basics/basicsimages/settings.png b/doc/user/gitlab-basics/basicsimages/settings.png Binary files differnew file mode 100644 index 00000000000..9bf9c5a0d39 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/settings.png diff --git a/doc/user/gitlab-basics/basicsimages/shh_keys.png b/doc/user/gitlab-basics/basicsimages/shh_keys.png Binary files differnew file mode 100644 index 00000000000..d7ef4dafe77 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/shh_keys.png diff --git a/doc/user/gitlab-basics/basicsimages/submit_new_issue.png b/doc/user/gitlab-basics/basicsimages/submit_new_issue.png Binary files differnew file mode 100644 index 00000000000..18944417085 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/submit_new_issue.png diff --git a/doc/user/gitlab-basics/basicsimages/title_description_mr.png b/doc/user/gitlab-basics/basicsimages/title_description_mr.png Binary files differnew file mode 100644 index 00000000000..e08eb628414 --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/title_description_mr.png diff --git a/doc/user/gitlab-basics/basicsimages/white_space.png b/doc/user/gitlab-basics/basicsimages/white_space.png Binary files differnew file mode 100644 index 00000000000..6363a09360e --- /dev/null +++ b/doc/user/gitlab-basics/basicsimages/white_space.png diff --git a/doc/user/gitlab-basics/command-line-commands.md b/doc/user/gitlab-basics/command-line-commands.md new file mode 100644 index 00000000000..addd3b6b6eb --- /dev/null +++ b/doc/user/gitlab-basics/command-line-commands.md @@ -0,0 +1,79 @@ +# Command Line basic commands + +## Start working on your project + +In Git, when you copy a project you say you "clone" it. To work on a git project locally (from your own computer), you will need to clone it. To do this, sign in to GitLab. + +When you are on your Dashboard, click on the project that you'd like to clone, which you'll find at the right side of your screen. + + + +To work in the project, you can copy a link to the Git repository through a SSH or a HTTPS protocol. SSH is easier to use after it's been [setup](create-your-ssh-keys.md). When you're in the project, click on the HTTPS or SSH button at the right side of your screen. Then copy the link (you'll have to paste it on your shell in the next step). + + + +## On the command line + +### Clone your project +Go to your computer's shell and type the following command: +``` +git clone PASTE HTTPS OR SSH HERE +``` + +A clone of the project will be created in your computer. + +### Go into a project, directory or file to work in it +``` +cd NAME-OF-PROJECT-OR-FILE +``` + +### Go back one directory or file +``` +cd ../ +``` + +### View what’s in the directory that you are in +``` +ls +``` + +### Create a directory +``` +mkdir NAME-OF-YOUR-DIRECTORY +``` + +### Create a README.md or file in directory +``` +touch README.md +nano README.md +#### ADD YOUR INFORMATION +#### Press: control + X +#### Type: Y +#### Press: enter +``` + +### Remove a file +``` +rm NAME-OF-FILE +``` + +### Remove a directory and all of its contents +``` +rm -rf NAME-OF-DIRECTORY +``` + +### View history in the command line +``` +history +``` + +### Carry out commands for which the account you are using lacks authority +You will be asked for an administrator’s password. +``` +sudo +``` + +### Tell where you are +``` +pwd +``` diff --git a/doc/user/gitlab-basics/create-branch.md b/doc/user/gitlab-basics/create-branch.md new file mode 100644 index 00000000000..7556b0f663e --- /dev/null +++ b/doc/user/gitlab-basics/create-branch.md @@ -0,0 +1,39 @@ +# How to create a branch + +A branch is an independent line of development. + +New commits are recorded in the history for the current branch, which results in taking the source from someone’s repository (the place where the history of your work is stored) at certain point in time, and apply your own changes to it in the history of the project. + +To add changes to your GitLab project, you should create a branch. You can do it in your [shell](basic-git-commands.md) or in GitLab. + +To create a new branch in GitLab, sign in and then select a project on the right side of your screen: + + + +Click on "commits" on the menu on the left side of your screen: + + + +Click on the "branches" tab: + + + +Click on the "new branch" button on the right side of the screen: + + + +Fill out the information required: + +1. Add a name for your new branch (you can't add spaces, so you can use hyphens or underscores) + +1. On the "create from" space, add the the name of the branch you want to branch off from + +1. Click on the button "create branch" + + + +### Note: + +You will be able to find and select the name of your branch in the white box next to a project's name: + + diff --git a/doc/user/gitlab-basics/create-group.md b/doc/user/gitlab-basics/create-group.md new file mode 100644 index 00000000000..f80ae62e442 --- /dev/null +++ b/doc/user/gitlab-basics/create-group.md @@ -0,0 +1,43 @@ +# How to create a group in GitLab + +## Create a group + +Your projects in GitLab can be organized in 2 different ways: +under your own namespace for single projects, such as ´your-name/project-1'; or under groups. +If you organize your projects under a group, it works like a folder. You can manage your group members' permissions and access to the projects. + +To create a group, follow the instructions below: + +Sign in to [GitLab.com](https://gitlab.com). + +When you are on your Dashboard, click on "Groups" on the left menu of your screen: + + + +Click on "New group" on the top right side of your screen: + + + +Fill out the information required: + +1. Add a group path or group name (you can't add spaces, so you can use hyphens or underscores) + +1. Add details or a group description + +1. You can choose a group avatar if you'd like + +1. Click on "create group" + + + +## Add a project to a group + +There are 2 different ways to add a new project to a group: + +* Select a group and then click on "New project" on the right side of your screen. Then you can [create a project](create-project.md) + + + +* When you are [creating a project](create-project.md), click on "create a group" on the bottom right side of your screen + + diff --git a/doc/user/gitlab-basics/create-issue.md b/doc/user/gitlab-basics/create-issue.md new file mode 100644 index 00000000000..5221d85b661 --- /dev/null +++ b/doc/user/gitlab-basics/create-issue.md @@ -0,0 +1,27 @@ +# How to create an Issue in GitLab + +The Issue Tracker is a good place to add things that need to be improved or solved in a project. + +To create an Issue, sign in to GitLab. + +Go to the project where you'd like to create the Issue: + + + +Click on "Issues" on the left side of your screen: + + + +Click on the "+ new issue" button on the right side of your screen: + + + +Add a title and a description to your issue: + + + +You may assign the Issue to a user, add a milestone and add labels (they are all optional). Then click on "submit new issue": + + + +Your Issue will now be added to the Issue Tracker and will be ready to be reviewed. You can comment on it and mention the people involved. You can also link Issues to the Merge Requests where the Issues are solved. To do this, you can use an [Issue closing pattern](http://docs.gitlab.com/ce/customization/issue_closing.html). diff --git a/doc/user/gitlab-basics/create-project.md b/doc/user/gitlab-basics/create-project.md new file mode 100644 index 00000000000..f737dffc024 --- /dev/null +++ b/doc/user/gitlab-basics/create-project.md @@ -0,0 +1,21 @@ +# How to create a project in GitLab + +To create a new project, sign in to GitLab. + +Go to your Dashboard and click on "new project" on the right side of your screen. + + + +Fill out the required information: + +1. Project path or the name of your project (you can't add spaces, so you can use hyphens or underscores) + +1. Your project's description + +1. Select a [visibility level](https://gitlab.com/help/public_access/public_access) + +1. You can also [import your existing projects](http://docs.gitlab.com/ce/workflow/importing/README.html) + +1. Click on "create project" + +! diff --git a/doc/user/gitlab-basics/create-your-ssh-keys.md b/doc/user/gitlab-basics/create-your-ssh-keys.md new file mode 100644 index 00000000000..f31c353f2cf --- /dev/null +++ b/doc/user/gitlab-basics/create-your-ssh-keys.md @@ -0,0 +1,33 @@ +# How to create your SSH Keys + +You need to connect your computer to your GitLab account through SSH Keys. They are unique for every computer that you link your GitLab account with. + +## Generate your SSH Key + +Create an account on GitLab. Sign up and check your email for your confirmation link. + +After you confirm, go to GitLab and sign in to your account. + +## Add your SSH Key + +On the left side menu, click on "profile settings" and then click on "SSH Keys": + + + +Then click on the green button "Add SSH Key": + + + +There, you should paste the SSH Key that your command line will generate for you. Below you'll find the steps to generate it: + + + +## To generate an SSH Key on your command line + +Go to your [command line](start-using-git.md) and follow the [instructions](../ssh/README.md) to generate it. + +Copy the SSH Key that your command line created and paste it on the "Key" box on the GitLab page. The title will be added automatically. + + + +Now, you'll be able to use Git over SSH, instead of Git over HTTP. diff --git a/doc/user/gitlab-basics/fork-project.md b/doc/user/gitlab-basics/fork-project.md new file mode 100644 index 00000000000..5f8b81ea919 --- /dev/null +++ b/doc/user/gitlab-basics/fork-project.md @@ -0,0 +1,19 @@ +# How to fork a project + +A fork is a copy of an original repository that you can put somewhere else +or where you can experiment and apply changes that you can later decide if +publishing or not, without affecting your original project. + +It takes just a few steps to fork a project in GitLab. + +Sign in to GitLab. + +Select a project on the right side of your screen: + + + +Click on the "fork" button on the right side of your screen: + + + +Click on the user or group to where you'd like to add the forked project. diff --git a/doc/user/gitlab-basics/start-using-git.md b/doc/user/gitlab-basics/start-using-git.md new file mode 100644 index 00000000000..89ce8bcc3e8 --- /dev/null +++ b/doc/user/gitlab-basics/start-using-git.md @@ -0,0 +1,122 @@ +# 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. + +## Open a shell + +Depending on your operating system, find the shell of your preference. Here are some suggestions. + +- [Terminal](http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line) on Mac OSX + +- [GitBash](https://msysgit.github.io) on Windows + +- [Linux Terminal](http://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/) on Linux + +## Check if Git has already been installed + +Git is usually preinstalled on Mac and Linux. + +Type the following command and then press enter: +``` +git --version +``` + +You should receive a message that will tell you which Git version you have in your computer. If you don’t receive a "Git version" message, it means that you need to [download Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). + +If Git doesn't automatically download, there's an option on the website to [download manually](https://git-scm.com/downloads). Then follow the steps on the installation window. + +After you finished installing, open a new shell and type "git --version" again to verify that it was correctly installed. + +## Add your Git username and set your email + +It is important because every Git commit that you create will use this information. + +On your shell, type the following command to add your username: +``` +git config --global user.name ADD YOUR USERNAME +``` + +Then verify that you have the correct username: +``` +git config --global user.name +``` + +To set your email address, type the following command: +``` +git config --global user.email ADD YOUR EMAIL +``` + +To verify that you entered your email correctly, type: +``` +git config --global user.email +``` + +You'll need to do this only once because you are using the "--global" option. It tells Git to always use this information for anything you do on that system. If you want to override this with a different username or email address for specific projects, you can run the command without the "--global" option when you’re in that project. + +## Check your information + +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 +``` |
