swift/doc/source/index.rst

107 lines
2.4 KiB
ReStructuredText

..
Copyright 2010-2012 OpenStack Foundation
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Welcome to Swift's documentation!
=================================
Swift is a highly available, distributed, eventually consistent object/blob
store. Organizations can use Swift to store lots of data efficiently, safely, and cheaply.
This documentation is generated by the Sphinx toolkit and lives in the source
tree. Additional documentation on Swift and other components of OpenStack can
be found on the `OpenStack wiki`_ and at http://docs.openstack.org.
.. _`OpenStack wiki`: http://wiki.openstack.org
.. note::
If you're looking for associated projects that enhance or use Swift, please see the :ref:`associated_projects` page.
.. toctree::
:maxdepth: 1
getting_started
Overview and Concepts
=====================
.. toctree::
:maxdepth: 1
Swift's API docs <http://docs.openstack.org/api/openstack-object-storage/1.0/content/>
overview_architecture
overview_ring
overview_reaper
overview_auth
overview_replication
ratelimit
overview_large_objects
overview_object_versioning
overview_container_sync
overview_expiring_objects
cors
crossdomain
associated_projects
Developer Documentation
=======================
.. toctree::
:maxdepth: 1
development_guidelines
development_saio
development_auth
development_middleware
development_ondisk_backends
Administrator Documentation
===========================
.. toctree::
:maxdepth: 1
howto_installmultinode
deployment_guide
apache_deployment_guide
admin_guide
replication_network
logs
Source Documentation
====================
.. toctree::
:maxdepth: 2
ring
proxy
account
container
db
object
misc
middleware
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`