[ovirt-users] Documentation

[Tom Gamull]

The docs do suck but I would challenge you to submit a pull request.  It’s a pain if you haven’t done github forks and pull requests.  However, if you do this and it doesn’t get merged, you have every right to complain and I’ll be behind you 100%.  I’ve been in your shoes and just recently started helping in little bits on some projects.

If you can fork the documents, change them to include your notes, I’d be happy to hand hold or explain how to do the pull request (think merging your changes back). you can even email me direct if needed.

Tom Gamull


> On Sep 4, 2016, at 4:26 PM, Brett I. Holcomb <biholcomb at l1049h.com> wrote:
> 
> Yeah, its frustrating for sure as I spent a lot of wasted time trying to figure out what applied, what didn't, what was out of date and a lot of what did apply assumed I already knew parts I needed.   I came from VMware and Hyper-V worlds and really like oVirt and what it's doing but the documentation can be frustrating for sure.  Unfortunately, that seems to be the way of a lot of OpenSource and along with that very few people like to do documentation and when they do it's from the perspective of someone who already knows the answers so it really doesn't help a brand new person who has no clue.  I had to do several hosted engine installs before I got it working (the stupid installer can't recover from an error so it makes you start over) on 3.6 (thanks be to VMware Workstation that let me start over <G>).  I took a lot of notes  and when I get time I'll post them. I know some will say we should contribute to the docs but I know I already have a full schedule with work and family and can't do anymore.
> 
> I've found this mailing list is the best source of information and sometimes they can link to sources we haven't found.  The people in this group are really knowledgeable and helpful so until the do get updated docs ask here.
> 
> On 09/04/2016 04:14 PM, zero four wrote:
>> As a prospective user of oVirt I have noticed quite a lot of glaring problems with the documentation, is it still being maintained?  Since outdated or incomplete documentation is often worse than nothing, a possible solution would be to just link to the official Red Hat Virtualization documentation.
>> Here are some examples I found after looking for less than 5 minutes:
>> 1. 
>>  <http://www.ovirt.org/documentation/>http://www.ovirt.org/documentation/ <http://www.ovirt.org/documentation/>
>> The top of this web page has two videos from 2012. The left one "oVirt Open Virtualization Basics -- Single Machine Install" is a guide for the all in one install.  This is misleading as it no longer possible to perform an all in one install since 3.6, and in general it would appear the oVirt project does not support deploying oVirt to a single machine. The right video is a guide on creating VMs using the GUI from 2012 which has since changed.
>> Overall both videos should be removed from the Documentation page as they only confuse and mislead new users.  I, and I am sure many other users would greatly appreciate more current video guides.
>> 2.
>>  <https://www.ovirt.org/documentation/how-to/hosted-engine/#fresh-install>https://www.ovirt.org/documentation/how-to/hosted-engine/#fresh-install <https://www.ovirt.org/documentation/how-to/hosted-engine/#fresh-install>
>> Under the notes for this there is the following passage:
>> 	“Although hosted-engine and engine-setup use different wording for the admin password 	("'admin at internal' user password" vs "Engine admin password"), they are asking for the same 	thing. If you enter different passwords, the hosted-engine setup will fail.”
>> Why is the wording different?  This appears to be entirely unnecessary, and also confusing as to why it is asking for the password a second time at all.
>> 3.
>>  <https://www.ovirt.org/documentation/how-to/hosted-engine/#fresh-install>https://www.ovirt.org/documentation/how-to/hosted-engine/#fresh-install <https://www.ovirt.org/documentation/how-to/hosted-engine/#fresh-install>
>> After finishing the hosted engine deployment script the guide states:
>> 	“After completing the OS installation on the VM, return to the host and continue. The installer 	on the host will sync with the VM and ask for the 	engine to be installed on the new VM:”
>> It is unclear how you are expected to access the VM, is the Web UI up at this point?  Do you need to use virsh to connect to the VM?  The guide should be explicit.
>> 4.
>>  <https://www.ovirt.org/documentation/quickstart/quickstart-guide/#prerequisites>https://www.ovirt.org/documentation/quickstart/quickstart-guide/#prerequisites <https://www.ovirt.org/documentation/quickstart/quickstart-guide/#prerequisites>
>>  I. The documentation discusses Fedora 19, Fedora is currently on version 24 and 19 is EOL.
>> II. Under “Storage and Networking” there is no mention that oVirt requires at least 3 GlusterFS bricks to achieve quorum.
>> III. Under “Virtual Machines” there is no mention of Windows 10, Fedora past version 20, or RHEL/CentOS 7.X.
>> 
>> 
>> _______________________________________________
>> 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
> http://lists.ovirt.org/mailman/listinfo/users

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ovirt.org/pipermail/users/attachments/20160904/496ac031/attachment-0001.html>