[ovirt-users] do we need some documentation mainteiners?

Wed May 10 08:27:27 UTC 2017

I'm might be saying things in a harsh way, but there is a real big problem with public documentation at ovirt, especially the latest python sdk.

I'm coding a python wrapper around the sdk4 and fighting a lot with documentation. 

First I tried to google:
ovirt python sdk4
ovirt python sdk 4
ovirt rest api 4

I was finally given http://ovirt.github.io/ovirt-engine-sdk/master, but http://ovirt.github.io returns a 404, the sdk is hidden under http://ovirt.github.io/ovirt-engine-sdk/, a mini-site that is barely usable, as it very hard to navigate between page. For example, when you're at : http://ovirt.github.io/ovirt-engine-sdk/master/version.m.html, how do you go to the first page ?

If I try to gogle the title of this page, I found http://www.ovirt.org/develop/release-management/features/infra/python-sdk/ as first result and it's even not in the first page of results .

Or you can have a look at https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html-single/python_sdk_guide/, that talks only about v3 sdk, which is deprecated.

The python sdk change log:
http://www.ovirt.org/develop/sdk/python-sdk-changelog/

At pypi, no links to the sdk documentation
https://pypi.python.org/pypi/ovirt-engine-sdk-python

I requested the events codes, I was given that:
https://github.com/oVirt/ovirt-engine/blob/master/backend/manager/modules/common/src/main/java/org/ovirt/engine/core/common/AuditLogType.java#L726

Is there a formal list somewhere ?

> Le 10 mai 2017 à 08:21, Oved Ourfali <oourfali at redhat.com> a écrit :
> 
> 
> 
> On Tue, May 9, 2017 at 11:46 PM, Fabrice Bacchella <fabrice.bacchella at orange.fr <mailto:fabrice.bacchella at orange.fr>> wrote:
> I'm whining because ovirt is a wonderful product, peoples behind are nice, but ho boy, what about the execution !
> 
> 
> I couldn't agree more with James here.
> It is good to whine, complain, and seek for improvements. We all want a better project!
> However, there are pleasant ways to express your thoughts and concerns. You seem to choose unpleasant ones, which are also unproductive and insulting to others.
> That can result in people not taking your thoughts and concerns in a serious way, as it is just unpleasant for them to read and reply to.
> I remember someone already sent you the community code of conduct [1]. I suggest you read that again before sharing your next post with us.
> 
> Oved
>  
> [1] https://www.ovirt.org/community/about/community-guidelines/ <https://www.ovirt.org/community/about/community-guidelines/>
> 
> And no I have done much more than empty complains as I have open my share a bug report, written a blog entry about using ovirt+kerberos+SSO, written a full fledged CLI and trying to finished the SDK. So I'm not just complaining.
> 
>> Le 9 mai 2017 à 22:28, James Michels <karma.sometimes.hurts at gmail.com <mailto:karma.sometimes.hurts at gmail.com>> a écrit :
>> 
>> Seriously, what's wrong with you? I've being reading your comments for some time and the only things I see are whining, unproductive complaining and disrespectful comments.
>> 
>> Please, stop it. There are tons of ways to say something, and the way you use is insulting for dozens of people developing this project. Most people here are seeking help and/or trying to be useful aiding others in what they can. If you don't like oVirt or you have that much complains maybe you should start your project yourself and do things like you consider they should be done.
>> 
>> James
>> 
>> 2017-05-09 15:59 GMT+01:00 Fabrice Bacchella <fabrice.bacchella at orange.fr <mailto:fabrice.bacchella at orange.fr>>:
>> The documentation is alway a good laugh at ovirt. Look for RHEL instead.
>> 
>>> Le 9 mai 2017 à 16:13, Juan Pablo <pablo.localhost at gmail.com <mailto:pablo.localhost at gmail.com>> a écrit :
>>> 
>>> Team, Is just me or the documentation pages are not being updated ? many are outdated.. how can we collaborate? 
>>> 
>>> whats up with http://www.ovirt.org/documentation/admin-guide/ <http://www.ovirt.org/documentation/admin-guide/> ?
>>> 
>>> regards,
>>> JP
>>> _______________________________________________
>>> Users mailing list
>>> Users at ovirt.org <mailto:Users at ovirt.org>
>>> http://lists.ovirt.org/mailman/listinfo/users <http://lists.ovirt.org/mailman/listinfo/users>
>> 
>> 
>> _______________________________________________
>> Users mailing list
>> Users at ovirt.org <mailto:Users at ovirt.org>
>> http://lists.ovirt.org/mailman/listinfo/users <http://lists.ovirt.org/mailman/listinfo/users>
>> 
>> 
>> _______________________________________________
>> Users mailing list
>> Users at ovirt.org <mailto:Users at ovirt.org>
>> http://lists.ovirt.org/mailman/listinfo/users <http://lists.ovirt.org/mailman/listinfo/users>
> 
> 
> _______________________________________________
> Users mailing list
> Users at ovirt.org <mailto:Users at ovirt.org>
> http://lists.ovirt.org/mailman/listinfo/users <http://lists.ovirt.org/mailman/listinfo/users>
> 
> 
> _______________________________________________
> Users mailing list
> Users at ovirt.org <mailto:Users at ovirt.org>
> http://lists.ovirt.org/mailman/listinfo/users <http://lists.ovirt.org/mailman/listinfo/users>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ovirt.org/pipermail/users/attachments/20170510/93d6d209/attachment-0001.html>