User Guides
(→Reference Material) |
(→Source Control) |
||
| Line 17: | Line 17: | ||
== Source Control == | == Source Control == | ||
| − | The documentation subproject has a git repository. Like the other oVirt git repositories it is managed using Gerrit. Follow the [[ | + | The documentation subproject has a git repository. Like the other oVirt git repositories it is managed using Gerrit. Follow the [[Working with oVirt Gerrit | instructions for registering with and using Gerrit]], then use the git clone command to get a local copy of the repository: |
$ git clone gerrit.ovirt.org:ovirt-docs | $ git clone gerrit.ovirt.org:ovirt-docs | ||
Revision as of 16:47, 9 July 2012
This page is intended to be the root of the oVirt documentation project. This will ultimately include links to the documentation as well as instructions for those wishing to contribute.
Contents |
License
Documentation is Copyright Ⓒ 2012 oVirt Project.
Licensed under the Apache License, Version 2.0 (the "License"). A copy of the License is included in this documentation; in addition, you may obtain a copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0
Guides
Source Control
The documentation subproject has a git repository. Like the other oVirt git repositories it is managed using Gerrit. Follow the instructions for registering with and using Gerrit, then use the git clone command to get a local copy of the repository:
$ git clone gerrit.ovirt.org:ovirt-docs
The git repository is intended to be used for the creation and maintenance of formal documentation for the project. At this time all formal documentation for the project is written in DocBookXML and turned into PDF, HTML, HTML-SINGLE, and EPUB output using publican.
Brand
The publican-ovirt brand is used to build the oVirt documentation. It is recommended that before building oVirt documentation you download and install this brand to ensure consistent theming. Users of Fedora 15, Fedora 16, and Fedora 17, may obtain the brand by running:
# yum install publican-ovirt
Alternatively the RPMs are available for download in koji. These are also expected to work on RHEL and derivative operating systems.
Users of other operating systems for which publican is available may obtain the source to the brand from the publican git repository. Once a local copy of the brand source has been created, follow the instructions in the Publican User Guide to build and install the brand.
Reference Material
Reference material includes any appropriately licensed information considered a useful reference for more formal documentation activity.
