summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn <john@admin-host.(none)>2012-05-23 15:44:11 -0700
committerJohn <john@admin-host.(none)>2012-05-23 15:44:11 -0700
commit3956cb8f19636aff96ffd2a69a70847c63962703 (patch)
tree0b1e4c4ba30550632151f92a07b3c766181d1bfc /doc
parentab04d95ad5c0adb0d114bd3546ee6d37613a2018 (diff)
downloadceph-3956cb8f19636aff96ffd2a69a70847c63962703.tar.gz
doc/api/s3 <-chipping away at objectops and clean up. Added Copy Object.
doc/source <-fixed a typo, updates for installing on precise, rm $ from cmds doc/start <-replaced clone link with tarball link. Link to Ceph Source Code. Signed-off-by: John Wilkins <john.wilkins@inktank.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/s3/commons.rst6
-rw-r--r--doc/api/s3/objectops.rst51
-rw-r--r--doc/source/build-prerequisites.rst4
-rw-r--r--doc/source/clone-source.rst74
-rw-r--r--doc/source/cloning-the-ceph-source-code-repository.rst43
-rw-r--r--doc/source/contributing.rst29
-rw-r--r--doc/source/get-tarballs.rst (renamed from doc/source/downloading-a-ceph-release.rst)0
-rw-r--r--doc/source/index.rst4
-rw-r--r--doc/start/get-involved.rst (renamed from doc/start/get-involved-in-the-ceph-community.rst)8
-rw-r--r--doc/start/index.rst2
10 files changed, 116 insertions, 105 deletions
diff --git a/doc/api/s3/commons.rst b/doc/api/s3/commons.rst
index 0b8e1f4f4c2..f102e52447a 100644
--- a/doc/api/s3/commons.rst
+++ b/doc/api/s3/commons.rst
@@ -1,6 +1,6 @@
-===============
-Common Entities
-===============
+=================
+ Common Entities
+=================
.. toctree::
:maxdepth: -1
diff --git a/doc/api/s3/objectops.rst b/doc/api/s3/objectops.rst
index 9f3c8c436e2..ea25aaf4fd3 100644
--- a/doc/api/s3/objectops.rst
+++ b/doc/api/s3/objectops.rst
@@ -44,34 +44,37 @@ Syntax
Request Headers
~~~~~~~~~~~~~~~
-+--------------------------------------+---------------+----------------+------------+
-| Name | Description | Valid Values | Required |
-+======================================+===============+================+============+
-| **x-amz-copy-source** | | | Yes |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-acl** | | | No |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-modified-since** | | | No |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-unmodified-since** | | | No |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-match** | | | No |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-none-match** | | | No |
-+--------------------------------------+---------------+----------------+------------+
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| Name | Description | Valid Values | Required |
++======================================+=================================================+========================+============+
+| **x-amz-copy-source** | The source bucket name + object name. | {bucket}/{obj} | Yes |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-acl** | A canned ACL. | ``private``, | No |
+| | | ``public-read``, | |
+| | | ``public-read-write``, | |
+| | | ``authenticated-read`` | |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-modified-since** | Copies only if modified since the timestamp. | Timestamp | No |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-unmodified-since** | Copies only if unmodified since the timestamp. | Timestamp | No |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-match** | Copies only if object ETag matches ETag. | Entity Tag | No |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-none-match** | Copies only if object ETag doesn't match. | Entity Tag | No |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
Response Entities
~~~~~~~~~~~~~~~~~
-+------------------------+-------------+---------------+
-| Name | Type | Description |
-+========================+=============+===============+
-| **CopyObjectResult** | Container | |
-+------------------------+-------------+---------------+
-| **LastModified** | Date | |
-+------------------------+-------------+---------------+
-| **Etag** | String | |
-+------------------------+-------------+---------------+
++------------------------+-------------+-----------------------------------------------+
+| Name | Type | Description |
++========================+=============+===============================================+
+| **CopyObjectResult** | Container | A container for the response elements. |
++------------------------+-------------+-----------------------------------------------+
+| **LastModified** | Date | The last modified date of the source object. |
++------------------------+-------------+-----------------------------------------------+
+| **Etag** | String | The ETag of the new object. |
++------------------------+-------------+-----------------------------------------------+
Remove Object
-------------
diff --git a/doc/source/build-prerequisites.rst b/doc/source/build-prerequisites.rst
index 7c62ea86282..640dda5148b 100644
--- a/doc/source/build-prerequisites.rst
+++ b/doc/source/build-prerequisites.rst
@@ -48,7 +48,7 @@ Ubuntu Requirements
-------------------
- ``uuid-dev``
-- ``libkeytutils-dev``
+- ``libkeyutils-dev``
- ``libgoogle-perftools-dev``
- ``libatomic-ops-dev``
- ``libaio-dev``
@@ -58,7 +58,7 @@ Ubuntu Requirements
Execute ``sudo apt-get install`` for each dependency that isn't installed on
your host. ::
- sudo apt-get install uuid-dev libkeytutils-dev libgoogle-perftools-dev libatomic-ops-dev libaio-dev libgdata-common libgdata13
+ sudo apt-get install uuid-dev libkeyutils-dev libgoogle-perftools-dev libatomic-ops-dev libaio-dev libgdata-common libgdata13
Debian
------
diff --git a/doc/source/clone-source.rst b/doc/source/clone-source.rst
new file mode 100644
index 00000000000..60eed07a560
--- /dev/null
+++ b/doc/source/clone-source.rst
@@ -0,0 +1,74 @@
+=========================================
+ Cloning the Ceph Source Code Repository
+=========================================
+
+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.
+
+Clone the Source
+----------------
+To clone the Ceph source code repository, execute::
+
+ git clone git@github.com:ceph/ceph.git
+
+Once ``git clone`` executes, you should have a full copy of the Ceph
+repository.
+
+Clone the Submodules
+--------------------
+Before you can build Ceph, you must navigate to your new repository and get
+the ``init`` submodule and the ``update`` submodule::
+
+ cd ceph
+ git submodule init
+ git submodule update
+
+.. tip:: Make sure you maintain the latest copies of these submodules.
+ Running ``git status`` will tell you if the submodules are out of date::
+
+ git status
+
+Choose a Branch
+---------------
+Once you clone the source code and submodules, your Ceph repository
+will be on the ``master`` branch by default, which is the unstable
+development branch. You may choose other branches too.
+
+- ``master``: The unstable development branch.
+- ``stable``: The bugfix branch.
+- ``next``: The release candidate branch.
+
+::
+
+ git checkout master
diff --git a/doc/source/cloning-the-ceph-source-code-repository.rst b/doc/source/cloning-the-ceph-source-code-repository.rst
deleted file mode 100644
index 72d52be6c6c..00000000000
--- a/doc/source/cloning-the-ceph-source-code-repository.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-=======================================
-Cloning the Ceph Source Code Repository
-=======================================
-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/>`_.
-
-Clone the Source
-----------------
-To clone the Ceph source code repository, execute::
-
- $ git clone git@github.com:ceph/ceph.git
-
-Once ``git clone`` executes, you should have a full copy of the Ceph repository.
-
-Clone the Submodules
---------------------
-Before you can build Ceph, you must navigate to your new repository and get the ``init`` submodule and the ``update`` submodule::
-
- $ cd ceph
- $ git submodule init
- $ git submodule update
-
-.. tip:: Make sure you maintain the latest copies of these submodules. Running ``git status`` will tell you if the submodules are out of date::
-
- $ git status
-
-Choose a Branch
----------------
-Once you clone the source code and submodules, your Ceph repository will be on the ``master`` branch by default, which is the unstable development branch. You may choose other branches too.
-
-- ``master``: The unstable development branch.
-- ``stable``: The bugfix branch.
-- ``next``: The release candidate branch.
-
-::
-
- git checkout master
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index ef63f26d9cf..6340cd49cec 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1,30 +1,5 @@
==========================
Contributing Source Code
==========================
-If you are making source contributions, you must be added to the Ceph
-project on github. You must also generate keys and add them to your
-github account.
-
-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 -d
-
-Get the key to add to your ``github`` account (the following example
-assumes you used the default file path)::
-
- cat .ssh/id_dsa.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.
+If you are making source contributions to the Ceph project,
+you must be added to the Ceph project on github. \ No newline at end of file
diff --git a/doc/source/downloading-a-ceph-release.rst b/doc/source/get-tarballs.rst
index 816795ab814..816795ab814 100644
--- a/doc/source/downloading-a-ceph-release.rst
+++ b/doc/source/get-tarballs.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 1f10d77adc2..8b80c5a4dc6 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,8 +10,8 @@ will save you time.
.. toctree::
Prerequisites <build-prerequisites>
- Get a Tarball <downloading-a-ceph-release>
- Clone the Source <cloning-the-ceph-source-code-repository>
+ Get a Tarball <get-tarballs>
+ Clone the Source <clone-source>
Build the Source <building-ceph>
Build a Package <build-packages>
Contributing Code <contributing>
diff --git a/doc/start/get-involved-in-the-ceph-community.rst b/doc/start/get-involved.rst
index 58af4a8f586..0a350a52212 100644
--- a/doc/start/get-involved-in-the-ceph-community.rst
+++ b/doc/start/get-involved.rst
@@ -27,9 +27,10 @@ These are exciting times in the Ceph community! Get involved!
| | requests using the Bug Tracker_. | |
+-----------------+-------------------------------------------------+-----------------------------------------------+
| **Source Code** | If you would like to participate in | |
-| | development, bug fixing, or if you just want | - http://github.com:ceph/ceph.git |
-| | the very latest code for Ceph, you can get it | - ``git clone git@github.com:ceph/ceph.git`` |
-| | at http://github.com. | |
+| | development, bug fixing, or if you just want | - http://github.com:ceph/ceph |
+| | the very latest code for Ceph, you can get it | - http://ceph.com/download |
+| | at http://github.com. See `Ceph Source Code`_ | |
+| | for details on cloning from github. | |
+-----------------+-------------------------------------------------+-----------------------------------------------+
| **Support** | If you have a very specific problem, an | http://inktank.com |
| | immediate need, or if your deployment requires | |
@@ -46,3 +47,4 @@ These are exciting times in the Ceph community! Get involved!
.. _Tracker: http://tracker.newdream.net/projects/ceph
.. _Blog: http://ceph.com/community/blog/
.. _support: http://inktank.com
+.. _Ceph Source Code: ../../source/ \ No newline at end of file
diff --git a/doc/start/index.rst b/doc/start/index.rst
index 62cbdeea933..29fa0ac6e2d 100644
--- a/doc/start/index.rst
+++ b/doc/start/index.rst
@@ -6,5 +6,5 @@ get started:
.. toctree::
- Get Involved <get-involved-in-the-ceph-community>
+ Get Involved <get-involved>
quick-start