Chapter 19. How to Update the Development Guide

This chapter discusses the process of updating the JBoss Development Process Guide.

The Process Guide is written using DocBook schema. To be able to keep it updated, a basic knowledge of DocBook is assumed. For reference and style manuals check the DocBook website

19.1. Checking Out The Guide As A Project

The Development Guide Project has two modules that need to be checked out separately.

  • guide modules - checked out from private cvs
  • guide build scripts (docbook-support module) - checked out from public cvs

To checkout the guide modules:


cvs	-d:ext:username@cvs.jboss.com:/opt/cvs/private/development/management co -r guide

			

To checkout the build scripts:


cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jboss	export -r HEAD docbook-support

			

The guide module includes the docBook content of the Development Guide - modules, stylesheets and images and the docbook-support module includes DocBook build scripts and is used to generate the html, single-html and pdf versions of the Development Guide. For any questions on accessing the cvs repository, refer to CVS Access .

19.2. Building The Modules

Building the modules is done through the guide's build.xml file, which is using targets defined in the docbok-suport module's build.xml . Make sure the following line in guide/build.xml is correct:


<import file="docbook-support/support.xml" />

			

The current version assumes the docbook module is in a directory called docbook-support inside your guide project folder. By executing the default target you will generate three different formats of the Guide - single-html, html and pdf, located in the build directory of your project. Currently the master.xml file specifies which modules of the guide are to be included in the build. If you add new files to the modules directory, you need to specify them in this file.



<! ENTITY qalab                    SYSTEM "modules/qalab.xml">					


			

This line declares a module entity later to be added to the build list.

19.3. Request Development Guide Update

Any updates to the Development Guide need to be requested by creating a JBQA issue in JIRA.