Instructions for authors
From NorduGrid
NorduGrid documentation is prepared in the code repository and later published via the NorduGrid Web site and/or distributed with the middleware releases.
All the documents must be located in the /doc folder of the repository. If a document consists of several files (e.g. a LaTeX file with bibliography and images), such a document must be placed in an own sub-folder of /doc.
The following raw formats are accepted:
- LaTeX (see templates in SVN)
- HTML (see templates in SVN)
For publishig purposes, LaTeX documents are used to produce PDF output (pdflatex tool is recommended).
Each document has an ID number:
- NORDUGRID-TECH-xx for technical descriptions
- NORDUGRID-MANUAL-xx for user manuals
- NORDUGRID-MEMO-xx for short instructions, typically related to 3rd party software
The number xx of the documents is incremental in each series separately; please check the list of existing documents for an available number, or consult the experts via the mailing list.
Non-ASCII formats like e.g. MS Word or OpenOffice are in general not accepted, though templates may exist. The idea is to avoid forcing authors using a specific editing tool, and to allow sensible diffs.
LyX can be used for document preparation by those who like it; however, the repository must always contain a valid .tex file, in order not to impose any tool upon other authors.
