From 949804eda4a85c3c960b0baa090e16f1aa48e95e Mon Sep 17 00:00:00 2001 From: John Dickinson Date: Mon, 16 Feb 2015 14:00:24 -0800 Subject: [PATCH] update the getting started doc Change-Id: I0a96bcf692bb240f3ab5aab7fefd294a07735a83 --- doc/source/getting_started.rst | 49 ++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 20 deletions(-) diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst index a21785322b..b3b201d461 100644 --- a/doc/source/getting_started.rst +++ b/doc/source/getting_started.rst @@ -7,38 +7,34 @@ System Requirements ------------------- Swift development currently targets Ubuntu Server 14.04, but should work on -most Linux platforms with the following software: +most Linux platforms. -* Python 2.6 or 2.7 +Swift is written in Python and has these dependencies: + +* Python 2.7 * rsync 3.0 +* The Python packages listed in `the requirements file `_ +* Testing additionally requires `the test dependencies `_ -And the following python libraries: - -* Eventlet 0.9.15 -* Setuptools -* Simplejson -* Xattr -* Nose -* Sphinx -* Netifaces -* Dnspython -* Pastedeploy - +Python 2.6 should work, but it's not actively tested. There is no current +support for Python 3. ------------- Getting Swift ------------- -Swift's source code is hosted on github and managed with git. The current trunk can be checked out like this: +Swift's source code is hosted on github and managed with git. The current +trunk can be checked out like this: ``git clone https://github.com/openstack/swift.git`` -A source tarball for the latest release of Swift is available on the `launchpad project page `_. +A source tarball for the latest release of Swift is available on the +`launchpad project page `_. -Prebuilt packages for Ubuntu are available starting with Natty, or from PPAs for earlier releases. +Prebuilt packages for Ubuntu and RHEL variants are available. * `Swift Ubuntu Packages `_ -* `Swift PPA Archive `_ +* `Swift RDO Packages `_ ----------- Development @@ -47,13 +43,26 @@ Development To get started with development with Swift, or to just play around, the following docs will be useful: -* :doc:`Swift All in One ` - Set up a VM with Swift installed +* :doc:`Swift All in One ` - Set up a VM with Swift + installed * :doc:`Development Guidelines ` +* `Associated Projects ` + +-------------------------- +CLI client and SDK library +-------------------------- + +There are many clients in the `ecosystem `_. The official CLI +and SDK is python-swiftclient. + +* `Source code `_ +* `Python Package Index `_ ---------- Production ---------- -If you want to set up and configure Swift for a production cluster, the following doc should be useful: +If you want to set up and configure Swift for a production cluster, the +following doc should be useful: * :doc:`Multiple Server Swift Installation `