DocsToDo

From Libvirt Wiki
Jump to: navigation, search

Libvirt Docs Team list of stuff to do

There's a pretty broad spectrum of things we need to get improved, and we can use this page as a starting point for working out what/when/how/etc.

Stuff that doesn't take any real virtualisation knowledge

The new Virsh Command Reference

Most pages just list the command name and the version of libvirt it was introduced in, without even showing the arguments the command can be given. This one for example:

http://libvirt.org/sources/virshcmdref/html/sect-list.html

Fixing this needs someone(s) who can run virsh "help" for a command, and then write down the options that command has.

We're using a really simple text format for this, so it's pretty easy. :)


Stuff that requires knowledge of an operating system, but not necessarily deep Virtualisation knowledge

Paths that need non Fedora/RHEL-ing

The existing docs on the libvirt.org website have been (mostly) written by people using path names that apply to Fedora and RHEL. It would be good to identify these, and update these to include the correct paths for other Linux distributions too, such as Ubuntu, OpenSUSE, Gentoo, and so on.

Probably the first thing that needs to be done for this is just someone to go through the pages on the website making a list of which ones have paths to be looked at. We can then figure out from there what it'll take, who needs to do what, etc. :)

Screenshots

Lots of the virt-manager pieces and processes could benefit from having good screenshots taken to show specific processes.

That's just a general thought, with no specific list at the moment. So, first step would be to figure out which processes, what needs screenshots, and so on.


Stuff that needs solid virtualiation knowledge

These things could really use a person that *does* have solid knowledge about some aspect of things, or a strong desire to learn it (then write it up). The two areas that jump out the most as needing attention here are:

Virtualisation storage concepts

There are some initial bits around "What is a storage pool? What is a storage volume? How do we use them?" in places in various docs, but nothing really nicely put together, targeted to general SysAdmin users.

Some of this info does exist in the Fedora or RHEL virtualisation guides, but they're distro specific and this info should be available on the libvirt.org or virt-tools.org websites themselves, and also cover other linux distro's.

Networking and virtualisation

All kinds of stuff here, from explaining how each of the virtual networking types work, through to explaining what a VirtIO network device is, and how to install the drivers for it in Windows.

All of which is directly of use to heaps of people, and still needs to be written.