Loading…
OpenStack Liberty Design Summit has ended
Wednesday, May 20 • 3:30pm - 4:10pm
Swift: Work session

Sign up or log in to save this to your schedule and see who's attending!

Work sessions are for Swift contributors to discuss implementation details and making quick progress over specific issues, in a small work group environment.

Documentation

Much of the documentation has moved into the swift repo. This is a good thing as it encourages us to keep the code and documentation
up to date. However, there are still a number of problems:
- Many features are documented multiple times. For example if you add a piece of middleware, you will find documentation
in common/middleware, doc/source/, doc/source/api
- There is no consistency about type of data. For exampe, some middleware docstrings provide both interface spec, configuration
information and usage notes -- frequently overlapping with information in other places. One reason the line count in
the recent service token patch was so large was because some data was repeated in several places
- Some documentation appears to be lost. When the API Spec (originally the Rackspace-derived PDF document) was moved
into swift's repo (on doc/api), many sections were considered to be usage information -- and not transfered. Hence, I can't
find anymore how you use prefix/path to access container listings or how pseudo directories work.

Proposal:
- Divide informaiton in three types of information: API specificaiton, configuration informaiton and usage information.
- Find appropriate homes
- For new features, use these new homes.


Donagh McCabe

Wednesday May 20, 2015 3:30pm - 4:10pm
Room 219
  • format json

Attendees (0)