Editing and Deploying the Torque site Thomas Fischer

This document is addressed to Torque committers who wish to edit and deploy the Torque site. If you find anything missing or wrong, please edit this document. If you find any procedure unsatisfactory, change it and document it here :-).

The Torque site consists of a "frame site" and the "sites" of the various components of Torque (== maven subprojects). The sites of the components are embedded in the main site (i.e. the user does not see that he has entered the component's site, as the navigation on the left hand side looks the same). In contrast to the subprojects, the "frame site" has no tags and branches in svn. (This is why you cannot get the frame site from the trunks svn directory).

Each subproject keeps its documentation in its own xdocs subdirectory. Currently, the templates subproject does not have its own documentation. There is also a subproject (docs-all-components) which contains documentation which affects mor than one subproject.

If you want to add new documents, please think about where they should be added:

As the navigation should look "the same" from the main site and each subproject, changes made to the "frame navigation", i.e. the navigation items which can be seen from every page of the site, must be made in the site subproject and the site of every component alike. (Probably there is some way to script this, but as this will probably be very different for a Maven 2 build, I do not think it is worth while now.)

If the change in the navigation affects a place which can not be seen from everywhere in the project (e.g. a new item in the "references" section of the runtime docs), there is no need to update the navigation.xml's of the other subprojects and the frame site.

This is a step-by-step guide to deploy the whole site. If you only want to deploy the documentation for a subproject, omit the steps to be omitted from the description below. The guide assumes that the necessary ssh properties and maven properties are set.

The following steps are necessary if a new release is created. I have not tested the procedure, so think yourself instead of following blindly (as always :-) )