openstack/swift
Code Issues Proposed changes
46d61a4dcd
swift/doc/source/getting_started.rst
Carlos Cavanna 5a7383313b Swift documentation for first-time contributors. 
In this change, there are proposed improvement to Swift documentation aimed at
first-time contributors. They include a simplification of the Getting
Started page and a new page with some basic instructions/commands that the
first-time contributor should know. In addition, it shows some common errors
that the first-time contributor may find when executing git rebase and
information on how to track your changes.

Change-Id: I704202955093736b2f3b4102a649690a0392c6b0
2015-07-29 21:40:28 -07:00

1.6 KiB
Raw Blame History

Getting Started

System Requirements

Swift development currently targets Ubuntu Server 14.04, but should work on most Linux platforms.

Swift is written in Python and has these dependencies:

There is no current support for Python 3.

Development

To get started with development with Swift, or to just play around, the following docs will be useful:

  • Swift All in One <development_saio> - Set up a VM with Swift installed
  • Development Guidelines <development_guidelines>
  • First Contribution to Swift <first_contribution_swift>
  • Associated Projects <associated_projects>

CLI client and SDK library

There are many clients in the ecosystem. The official CLI and SDK is python-swiftclient.

Production

If you want to set up and configure Swift for a production cluster, the following doc should be useful:

  • Multiple Server Swift Installation <howto_installmultinode>