Documentation

DataNucleus uses Maven site plugin for generating its documentation, and the documentation is stored in XDOC format typically.

datanucleus.org Project Site

DataNucleus has a main site datanucleus.org for the overall project and the commercial services that we offer. This site makes use of a "skin" responsible for adding header/footer to all docs as well as the dropdown menus. This "skin" is available in SVN at

documentation/datanucleus.org-maven-skin/trunk

Now you need to build/install the skin, by typing mvn clean install.

You can access the documentation for datanucleus.org in SVN at

documentation/datanucleus.org/trunk

Now you can build the site itself by typing mvn clean site. The site is then available under target/site. The documentation is also generated every night from what is in SVN, and this appears on the website.

AccessPlatform Product Site

The documentation for AccessPlatform uses the same Maven process, and also has its own "skin". The "skin" is available in SVN at.

documentation/accessplatform-maven-skin/trunk

Now you need to build/install the skin, by typing mvn clean install.

You can access the documentation for AccessPlatform in SVN at

documentation/accessplatform/trunk

Now you can build the site itself by typing mvn clean site and this is generated under target/site. You can also build a PDF of the docs by typing mvn clean pdf:pdf, and this is generated under target/pdf. The documentation is also generated every night from what is in SVN, and this appears on the website.