|
As you've seen from this website, DataNucleus uses a mix of its own designed web site, and a
Maven-generated site. The front page is the "public face" of
DataNucleus and so doesn't follow the Maven styling. The
docs
section of the website uses
Maven to generate the pages. This is achieved by running
All documents are stored under the
datanucleus.org
project, and there are subdirectories
for products, developer, project etc. There are in addition directories
JDO
and
JPA
to hold documents describing particular features of the specifications. All documents are in
xdoc XML
format. These have a simplified HTML style, and this style is used because it can be
translated by Maven (well by Velocity really) to give the generated site a look-and-feel (for example
to add on the side navigation, and the header area).
DataNucleus doesn't use the default Maven look. We have customised the style sheets used
(stored under
css
), the layout formatter template (
site.jsl
), and the navigation
(
navigation.xml
).
There are some aspects of DataNucleus that don't have adequate documentation. If you want to aid
us in documenting the system, for users and developers, please follow this process
-
Make sure you look under the release that the document applies to. Select the relevant
directory for the document to go.
-
Check for any existing document that describes what you are thinking of
-
If nothing exists, decide if the information is something a User would need to see,
or a Developer. This defines if you put it under the directory
development
,
or under
project
-
Write the document, using the
xdoc XML
format.
-
Add an index to the document in the navigation definition (
navigation.xml
).
The website is updated by the nightly build process, so your page will appear on the live site
with the following day after being added to SVN.
|
|
