Bug 1011312

Summary: [Docs] [Dev] Errors in Appendix A 'SDK Examples'
Product: Red Hat Enterprise Virtualization Manager Reporter: Andrew Burden <aburden>
Component: DocumentationAssignee: Andrew Burden <aburden>
Status: CLOSED CANTFIX QA Contact: ecs-bugs
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: unspecifiedCC: rbalakri, yeylon
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Build: CSProcessor Builder Version 1.12 Build Name: 12978, Developer Guide-3.3-1 Build Date: 20-08-2013 13:01:50 Topic ID: 13568-435328 [Latest]
Last Closed: 2014-09-17 01:57:35 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:

Description Andrew Burden 2013-09-24 04:47:52 UTC
As discussed in a separate bug:
(https://bugzilla.redhat.com/show_bug.cgi?id=1007394)

"
Looking at the Further_Python_SDK_Examples.html, imported config/states
are not a part of sdk nor any of our distributions and should be removed indeed,

also not sure where form these examples are coming, but there are tones of *bad*
code, like using sdk internals which are not a part of public interface and can
be changed at any time breaking client's code, i'll list few that you should be
removing from the guide [1], on other hand, you can include these [2] and/or you
may ask edolinin/imeerovi if you need more.

[1]

- A.2. Common Functions and Wrappers Header
- disconnect
- def _getApi():
- objectDescr

to be honest i'm not sure if we should be publishing any of examples
suggested by Dan, its few private/use-case driven implementations that
doesn't add any value, in my view, [2] is much better approach as it gives
generic view on sdk.

[2]

http://www.ovirt.org/Python-sdk#Examples
http://www.ovirt.org/Testing/PythonAp
"

Expected Results:
Remove current examples and rebuild using examples from [2] and any provided by SMEs

Comment 1 Andrew Burden 2014-08-18 05:28:09 UTC
This content was removed from the Developer Guide (now a part of the Technical Guide).

Comment 2 Andrew Burden 2014-09-17 01:57:35 UTC
This bug is being closed as the examples are no longer included in the documentation.