This page describes the processes involved in building various facets of the Maven-generated content.

Note: The

http://tapestry.apache.org

web site is now primarily generated from an export of the Confluence wiki, rather than via Maven. Currently only the Component Reference and API (Javadoc) pages are generated using Maven.

Maven

You will need to grab a current version of Maven and install it. This should be pretty straightforward following the maven instructions.

Top Level Site

To build the top level project site you will need to checkout the tapestry-site project from svn.

This project should hold nothing but documentation for the core site, as well as our custom Maven documentation theme skin which is under the sub directory maven-skin.

Building Site

For the most part this is all you need to do:

  • mvn site - Builds the site locally to your box. You can view the results and confirm that everything looks good by going to the target sub folder in your browser.
  • mvn site:deploy - Will deploy the site to http://tapestry.apache.org. Make sure it's good before it goes out!
  • mvn -Dmaven.test.skip=true site:deploy - If you are getting failed unit tests for some reason. (Shouldn't happen for top level site, but sub projects may have test errors).

Building Maven Skin

Before you can build the actual site you need to have the tapestry skin plugin installed. It is intended that this will be released officially at some point so that people don't need to do this, but for now you need to do the following:

cd maven-skin; mvn install;

That's it!

Settings.xml

The core site and anything that requires authentication will need a username at a minimum from you in order to be deployable. With Maven this is done via a settings.xml configuration file that is local to your machine only. If you are on a linux box it should be placed in ~/.m2/settings.xml.

Here is a sample settings.xml, you will need to make your server id match the name of tapestry if you want it to get picked up by the build.

<settings>
        <servers>
           <server>
                <username>jkuhnert</username>
                <id>tapestry</id>
           </server>
        </servers>
</settings>

Note that if your private key is in a non-standard location, add (in the server tag)

                <privateKey>/path/to/key</privateKey>
  • No labels