summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorkaren Carias <karen@gitlab.com>2015-06-16 16:05:56 -0700
committerkaren Carias <karen@gitlab.com>2015-06-16 16:05:56 -0700
commit60bee2843084bdee0521e348736f2bd3e118d554 (patch)
tree9b0accff68a55f3428a62a285466946c66edb698 /doc
parentadffe47d3c1549bac13a15868a1fb8071bd0d10d (diff)
downloadgitlab-ce-60bee2843084bdee0521e348736f2bd3e118d554.tar.gz
added starting a shell doc and index
Diffstat (limited to 'doc')
-rw-r--r--doc/gitlab_basics/README.md6
-rw-r--r--doc/gitlab_basics/starting_a_shell.md67
2 files changed, 73 insertions, 0 deletions
diff --git a/doc/gitlab_basics/README.md b/doc/gitlab_basics/README.md
new file mode 100644
index 00000000000..15fc8b83dbf
--- /dev/null
+++ b/doc/gitlab_basics/README.md
@@ -0,0 +1,6 @@
+# GitLab basics
+
+Step-by-step guides on the basics of working with Git and GitLab.
+
+* [Starting a shell in your computer](starting_a_shell.md)
+
diff --git a/doc/gitlab_basics/starting_a_shell.md b/doc/gitlab_basics/starting_a_shell.md
new file mode 100644
index 00000000000..c93b18d53d3
--- /dev/null
+++ b/doc/gitlab_basics/starting_a_shell.md
@@ -0,0 +1,67 @@
+# Starting a shell in your computer
+
+If you want to start using a shell and GitLab, make sure that you have created an account on [gitlab.com](https://about.gitlab.com/)
+
+## Open a shell in your computer
+
+* Depending on your operating system, find the shell of your preference in your computer. 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 in your computer
+
+* 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
+```
+
+* And you should get your username
+
+* 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
+```