User Documentation

Contents

[edit]

Documentation

oVirt has an active community working towards developing documentation for oVirt products. Presently oVirt has three books, all of which are works in progress. These books include: Using oVirt, the oVirt Server Suite Installation Guide and the oVirt Node Deployment Guide.

[edit]

Using oVirt

Using oVirt is a step by step guide for using the oVirt Appliance web-based user interface.

Using oVirt is available here [[1]] or as a PDF.

[edit]

oVirt Server Suite Installation Guide

This guide is presently a work in progress.

[edit]

oVirt Node Deployment Guide

This guide is presently a work in progress.

[edit]

Developing oVirt documentation

The source for all the oVirt books and other miscellaneous documents is hosted on git. To download it and start developing: 

 $ git clone git://git.et.redhat.com/ovirt-docs.git

All the oVirt books are written in Docbook XML [[2]] and compiled with publican. Publican is an open source publishing tool available for fedora, Red Hat Enterprise Linux and CentOS. To install publican, execute the following command: 

 # yum install publican-ovirt publican

To make a book with publican, first enter the books directory. For example: 

 $ cd ovirt-docs/oVirt_Node_Deployment_Guide

Then use: 

 $ make html-en-US
 $ make html-single-en-US
 $ make pdf-en-US
Retrieved from "http://www.ovirt.org/page/User_Documentation"
MediaWiki