78cce72f8a
This patch standardizes the CONTRIBUTING.rst file and adds the required doc/source/contributor/contributing.rst Swift already had a detailed CONTIRBUTING.rst and an informative REVIEW_GUIDELINES.rst in the root of the repo. So we are also pulling them into the contributor documentation so they can not only be easily found in the checked repo but in the online documentation. Change-Id: I4c84efbe50eb25ab922c9d6b69198dae341af48b
4.0 KiB
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.
Note
If you're looking for associated projects that enhance or use Swift,
please see the associated_projects page.
getting_started
Overview and Concepts
api/object_api_v1_overview overview_architecture overview_ring overview_policies overview_reaper overview_auth overview_acl overview_replication ratelimit overview_large_objects overview_global_cluster overview_container_sync overview_expiring_objects cors crossdomain overview_erasure_code overview_encryption overview_backing_store overview_container_sharding ring_background ring_partpower associated_projects
Contributor Documentation
contributor/contributing contributor/review_guidelines
Developer Documentation
development_guidelines development_saio first_contribution_swift policies_saio development_auth development_middleware development_ondisk_backends
Administrator Documentation
howto_installmultinode deployment_guide apache_deployment_guide admin_guide replication_network logs ops_runbook/index admin/index install/index
Object Storage v1 REST API Documentation
See Complete Reference for the Object Storage REST API
The following provides supporting information for the REST API:
api/object_api_v1_overview.rst api/discoverability.rst api/authentication.rst api/container_quotas.rst api/object_versioning.rst api/large_objects.rst api/temporary_url_middleware.rst api/form_post_middleware.rst api/use_content-encoding_metadata.rst api/use_the_content-disposition_metadata.rst api/pseudo-hierarchical-folders-directories.rst api/pagination.rst api/serialized-response-formats.rst api/static-website.rst api/object-expiration.rst api/bulk-delete.rst
S3 Compatibility Info
s3_compat
OpenStack End User Guide
The OpenStack End User Guide has additional information on using Swift. See the Manage objects and containers section.
Source Documentation
ring proxy account container db object misc middleware
Indices and tables
genindexmodindexsearch