Brett Porter has set up the sandbox so that it is possible to use Maven 2 to build the site for commons sandbox components.
Instructions
- Download latest integration build from http://maven.zones.apache.org/~maven/builds/branches/maven-2.0.x/ and install per normal m2 instructions (the site will require Maven 2.0.2, due for release in the next couple of weeks)
- run "mvn site" from trunks-sandbox
Comments
Dennis Lundberg:
- The sites look very similar to the current ones regarding look-and-feel, but there are some small differences
Links to individual components are absolute, both in the menu and in the table, meaning that you can't click on the generated sandbox front page. If you do you end up on the live site. See [http://jira.codehaus.org/browse/MSITE-62 MSITE-62]
- The left hand side meny ends where the menuitems ends. Previously it went on all the way down to where the text in the main area ended. This new behaviour looks better.
The copyright notice at the bottom is now right-aligned (before it was left-aligned) and a bit smaller than before. See [http://jira.codehaus.org/browse/MSITE-66 MSITE-66]
- There is no text "Doc for <version>" to the right of the publishing date
Converting from Maven 1
- If you run into trouble, have a look at the sandbox components exec and openpgp. They are using Maven 2 for site generation.
- Add the component as a <module> to the <modules> section in <sandbox>/pom.xml
- Convert <component>/project.xml to <component>/pom.xml. A tool that helps doing this is being worked on by the Maven community. For now you have to do it manually.
- Convert <component>/xdocs/navigation.xml to <component>/site/site.xml. They are very similar so there should be no problems.
- Move the folder <component>/xdocs/ to <component>/site/xdoc/ (Note: the new folder is called xdoc not xdocs). Exclude the file navigation.xml since it is replaced by the file site.xml.