update versioning docs

Bug #1485839 reported by John Dickinson
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Object Storage (swift)
Fix Released
Medium
Thiago da Silva

Bug Description

doc/source/api/object_versioning.rst refers to old (pre-middleware) ways to enable versioning. These instructions need to be updated (and the rest of the document audited too).

Changed in swift:
importance: Undecided → Medium
Matthew Oliver (matt-0)
Changed in swift:
status: New → Confirmed
Revision history for this message
Thiago da Silva (thiagodasilva) wrote :

How about we remove that page all together? Comparing http://docs.openstack.org/developer/swift/api/object_versioning.html and
http://docs.openstack.org/developer/swift/middleware.html#module-swift.common.middleware.versioned_writes , the information there looks very very similar, so instead of duplicating information, I'd just update what's in the middleware source code and remote the doc/source/api/object_versioning.rst

Thoughts??

Revision history for this message
John Dickinson (notmyname) wrote :

The API docs should be how to use it from an end-user perspective. No need to have configuration and cluster-enablement there.

The middleware docs should refer to the API docs for usage and should cover how to deploy, migrate, configure.

I think there is a role for both docs.

Revision history for this message
Thiago da Silva (thiagodasilva) wrote :

The api-docs [1] were updated as part of the history mode patch to object versioning. I think this is now ready to be marked as 'Fixed released'

[1] - http://docs.openstack.org/developer/swift/api/object_versioning.html

Changed in swift:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.