Bug 852217

Summary: Docs/comments lacking for stickshift plugins
Product: OpenShift Online Reporter: Luke Meyer <lmeyer>
Component: PodAssignee: Krishna Raman <kraman>
Status: CLOSED WONTFIX QA Contact: libra bugs <libra-bugs>
Severity: low Docs Contact:
Priority: medium    
Version: 2.xCC: bhatiam, mfisher, mmcgrath, mpatel
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-07-22 15:48:20 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Luke Meyer 2012-08-27 21:44:35 UTC
Description of problem:

Docs/comments lacking in crankcase: stickshift/controller/lib/stickshift-controller/lib/stickshift/*.rb

Also, contents are inconsistent.

  
Actual results:

No docs or comments in these files. Also, mongo_data_store.rb is an implementation, not an interface.


Expected results:

Of all the code in the product, the part that defines an interface for folks to swap in their own plugins seems like the best candidate for good documentation and comments, but neither is to be found here. Please supply both.

Also, either move mongo_data_store.rb to where it will not give the impression that it could be plugged-out, or abstract it properly.


Additional info:

mmcgrath said I should file bugs for these things :)

Comment 1 Mike McGrath 2012-10-10 19:00:01 UTC
Reassigning to Krishna

  - Bug Triage Meeting