From 5f38703bdc6a8c0d6193d51155f1d5bf6a30c341 Mon Sep 17 00:00:00 2001 From: karen Carias Date: Mon, 29 Jun 2015 18:53:51 -0700 Subject: [PATCH] split to 2 documents --- doc/gitlab_basics/README.md | 2 + doc/gitlab_basics/basic_git_commands.md | 111 +++++++++++++++++++ doc/gitlab_basics/command_line_commands.md | 119 +-------------------- 3 files changed, 117 insertions(+), 115 deletions(-) create mode 100644 doc/gitlab_basics/basic_git_commands.md diff --git a/doc/gitlab_basics/README.md b/doc/gitlab_basics/README.md index 7a027326e80..a2edede5f1c 100644 --- a/doc/gitlab_basics/README.md +++ b/doc/gitlab_basics/README.md @@ -7,3 +7,5 @@ Step-by-step guides on the basics of working with Git and GitLab. * [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) diff --git a/doc/gitlab_basics/basic_git_commands.md b/doc/gitlab_basics/basic_git_commands.md new file mode 100644 index 00000000000..895876c41d9 --- /dev/null +++ b/doc/gitlab_basics/basic_git_commands.md @@ -0,0 +1,111 @@ +# Basic Git commands + +It's important to know some basic commands to work on your shell + +* Go into a project, directory or file to work in it +``` +cd NAME-OF-PROJECT-OR-FILE +``` + +* Go back one directory or file +``` +cd ../ +``` + +* Go to the master branch to pull the latest changes from there +``` +git checkout master +``` + +* Download the latest changes in the project, so that you work on an up-to-date copy (this 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 (remember that spaces won't be recognized, 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 +``` + +* To see 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 +``` + +* To see 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 be able to 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 origin NAME-OF-BRANCH +``` + +* Remove a file +``` +rm NAME-OF-FILE +``` + +* Remove a directory and all of its contents +``` +rm -rf NAME-OF-DIRECTORY +``` + +* Throw away 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 +``` + +* View history in terminal +``` +history +``` + +* Remove all the changes that you don't want to send to gitlab.com +``` +git add NAME-OF-FILE -all +``` + +* Merge created branch with master branch. You need to be in the created branch +``` +git checkout NAME-OF-BRANCH +git merge master +``` + +* Carry out commands for which the account you are using lacks authority. (You will be asked for an administrator’s password) +``` +sudo +``` diff --git a/doc/gitlab_basics/command_line_commands.md b/doc/gitlab_basics/command_line_commands.md index d780f2c47e8..64141187595 100644 --- a/doc/gitlab_basics/command_line_commands.md +++ b/doc/gitlab_basics/command_line_commands.md @@ -2,17 +2,17 @@ ## Start working on your project -* In Git, when you copy a project you say you "clone" it. You need to clone the contents in the project that you’d like to work on to your computer. To do it, go to your [gitlab.com](https://gitlab.com) account +* 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, start by signing in at GitLab.com.. To do it, go to your [gitlab.com](https://gitlab.com) account * 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 ![Select a project](basicsimages/select_project.png) -* When you're in the project, click on the HTTPS button at the right side of your screen. Then copy the HTTPS link (you'll have to paste it on your shell in the next step) +* 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 [set up](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) ![Copy the HTTPS](basicsimages/https.png) -## In your Command Line or shell +## On the command line * To clone your project, go to your computer's shell and type the following command @@ -20,115 +20,4 @@ git clone PASTE HTTPS HERE ``` -* A clone of the project will be created in your computer. You'll be able to find it stored as a regular file - -## Basic commands - -It's important to know some basic commands to work on your shell - -* Go into a project, directory or file to work in it -``` -cd NAME-OF-PROJECT-OR-FILE -``` - -* Go back one directory or file -``` -cd ../ -``` - -* Go to the master branch to pull the latest changes from there -``` -git checkout master -``` - -* Download the latest changes in the project, so that you work on an up-to-date copy (this is important to do every time you work on a project) -``` -git pull -``` - -* Create a branch (remember that spaces won't be recognized, 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 -``` - -* To see what’s in the file -``` -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 -``` - -* To see 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 be able to see your changes in red when you type "git status") -``` -git add CHANGES IN RED -git commit -m "DESCRIBE COMMIT IN A FEW WORDS" -``` - -* Send changes to gitlab.com -``` -git push origin NAME-OF-BRANCH -``` - -* Move a file -``` -mv NAME-OF-FILE -``` - -* Rename a file -``` -rn NAME-OF-FILE -``` - -* Remove a file -``` -rm NAME-OF-FILE -``` - -* Remove a directory -``` -rm -r NAME-OF-DIRECTORY -``` - -* Delete changes -``` -git clean -f -``` - -* View history in terminal -``` -history -``` - -* Remove all the changes that you don't want to send to gitlab.com -``` -git add NAME-OF-FILE -all -``` - -* Merge created branch with master branch. You need to be in the created branch -``` -git checkout NAME-OF-BRANCH -git merge master -``` +* A clone of the project will be created in your computer