From ecb5acfc3a179872ea67e9197f545eecdfa1871a Mon Sep 17 00:00:00 2001 From: Mike Perez Date: Wed, 23 Mar 2016 10:32:17 -0700 Subject: [PATCH] Create git setup/learn guide This goes along with the recent irc guide addition for upstream university participants to come complete before attending the event. Change-Id: I71ae04520b7693a286e59d1cbfc740a5488f7a39 --- doc/upstream-training/git.rst | 80 +++++++++++++++++++++++++++++++++ doc/upstream-training/index.rst | 1 + 2 files changed, 81 insertions(+) create mode 100644 doc/upstream-training/git.rst diff --git a/doc/upstream-training/git.rst b/doc/upstream-training/git.rst new file mode 100644 index 00000000..32f2fd2e --- /dev/null +++ b/doc/upstream-training/git.rst @@ -0,0 +1,80 @@ +################### +Setup and Learn GIT +################### + +Setup For Mac OS & Linux +======================== + +We'll first install git. + +For Mac OS: + +#. Go to the Git `download page `_ and click + **Mac OS X**. +#. The downloaded file should be a dmg in your downloads folder. Open that dmg + file and follow the instructions on screen. + +For Linux distributions like Debian, Ubuntu, or Mint open a terminal and type:: + + sudo apt-get install git + +For Linux distributions like Redhat, Fedora 21 or earlier, or Centos open +a terminal and type:: + + sudo yum install git + +For Fedora 22 or later open a terminal and type:: + + sudo dnf install git + +For openSUSE 12.2 and later open a terminal and type:: + + sudo zypper in git + +Configure Git +------------- + +Once you have Git installed you need to configure it. Open your terminal +application and issue the following commands putting in your first/last name +and email address. This is how your contributions will be identified:: + + git config --global user.name "Firstname Lastname" + git config --global user.email "your_email@youremail.com" + +Installing git-review +--------------------- + +git-review adds a subcommand to git that handles working with Gerrit, the code +review system used by OpenStack. + +For Mac OS:: + + pip install git-review + +If you don't have pip installed already, follow the `installation documentation +`_ for +pip. + +For Linux distributions like Debian, Ubuntu, or Mint open a terminal and type:: + + sudo apt-get install git-review + +For Linux distributions like Redhat, Fedora 21 or earlier, or Centos open +a terminal and type:: + + sudo yum install git-review + +For Fedora 22 or later open a terminal and type:: + + sudo dnf install git-review + +For openSUSE 12.2 and later open a terminal and type:: + + sudo zypper in python-git-review + + +Learning Git +============ + +You can use `Git Immersion `_ to work +through tutorials for learning git. diff --git a/doc/upstream-training/index.rst b/doc/upstream-training/index.rst index 4d8004ad..058318fd 100644 --- a/doc/upstream-training/index.rst +++ b/doc/upstream-training/index.rst @@ -52,6 +52,7 @@ How to prepare * Check that you can ssh from your laptop to the virtual machine * Check that :command:`apt-get install` works on the virtual machine * Read and complete the :doc:`irc` guide. +* Read and complete the :doc:`git` guide. * Get in touch with the team upstream-training@openstack.org to pick a contribution to work on.