diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/clone-source.rst | 35 | ||||
| -rw-r--r-- | doc/source/git.rst | 43 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 |
3 files changed, 46 insertions, 33 deletions
diff --git a/doc/source/clone-source.rst b/doc/source/clone-source.rst index 60eed07a560..e2bc95de2e3 100644 --- a/doc/source/clone-source.rst +++ b/doc/source/clone-source.rst @@ -1,40 +1,9 @@ ========================================= Cloning the Ceph Source Code Repository ========================================= +To clone the source, you must install Git. See `Set Up Git`_ for details. -To check out the Ceph source code, you must have ``git`` installed -on your local host. To install ``git``, execute:: - - sudo apt-get install git - -You must also have a ``github`` account. If you do not have a -``github`` account, go to `github.com <http://github.com>`_ and register. -Follow the directions for setting up git at -`Set Up Git <http://help.github.com/linux-set-up-git/>`_. - -Generate SSH Keys ------------------ -You must generate SSH keys for github to clone the Ceph -repository. If you do not have SSH keys for ``github``, execute:: - - ssh-keygen - -Get the key to add to your ``github`` account (the following example -assumes you used the default file path):: - - cat .ssh/id_rsa.pub - -Copy the public key. - -Add the Key ------------ -Go to your your ``github`` account, -click on "Account Settings" (i.e., the 'tools' icon); then, -click "SSH Keys" on the left side navbar. - -Click "Add SSH key" in the "SSH Keys" list, enter a name for -the key, paste the key you generated, and press the "Add key" -button. +.. _Set Up Git: ../git Clone the Source ---------------- diff --git a/doc/source/git.rst b/doc/source/git.rst new file mode 100644 index 00000000000..2d90e52c0e8 --- /dev/null +++ b/doc/source/git.rst @@ -0,0 +1,43 @@ +============ + Set Up Git +============ +To check out the Ceph source code, you must have ``git`` installed +on your local host. + +Install Git +----------- +To install ``git``, execute:: + + sudo apt-get install git + +You must also have a ``github`` account. If you do not have a +``github`` account, go to `github.com`_ and register. +Follow the directions for setting up git at +`Set Up Git`_. + +.. _github.com: http://github.com +.. _Set Up Git: http://help.github.com/linux-set-up-git + +Generate SSH Keys +----------------- +You must generate SSH keys for github to clone the Ceph +repository. If you do not have SSH keys for ``github``, execute:: + + ssh-keygen + +Get the key to add to your ``github`` account (the following example +assumes you used the default file path):: + + cat .ssh/id_rsa.pub + +Copy the public key. + +Add the Key +----------- +Go to your your ``github`` account, +click on "Account Settings" (i.e., the 'tools' icon); then, +click "SSH Keys" on the left side navbar. + +Click "Add SSH key" in the "SSH Keys" list, enter a name for +the key, paste the key you generated, and press the "Add key" +button.
\ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 8b80c5a4dc6..66c91f9212e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,7 @@ will save you time. Prerequisites <build-prerequisites> Get a Tarball <get-tarballs> + Set Up Git <git> Clone the Source <clone-source> Build the Source <building-ceph> Build a Package <build-packages> |