Apache » Cocoon »

Apache Cocoon homepage

Apache Cocoon

How to build the site locally

This page explains how to build the Cocoon 2.2 documentation site with Maven2 and the daisy-maven-plugin.

This plugin assumes that each block has its own collection and navigation document.

Configure settings.xml

The documents can only be exported by a user with admin rights to the Daisy repository. We have created such a user daisy-export. The password for this user is available in a daisy-export-user-password.txt file in the home directory of the daisy user. If you want to use your own Daisy user, make sure that you have administration rights.

Open the ~/.m2/setting.xml and add the following:

<settings>

 [...]

 <profiles>
    <profile>
       <id>localDocs</id>
       <properties>
          <docs.deploymentBaseUrl>file:///cocoon-site</docs.deploymentBaseUrl>
       </properties>
     </profile>
 </profiles>  
  
 <servers>
    <server>
       <id>cocoon-daisy</id>
       <username>daisy-export</username>
       <password>SECRET PASSWORD HERE</password>
    </server>
 </servers>

</settings>

Build all modules required for the site generation

cd trunk
mvn install -P daisy

Build the site

cd trunk/site
mvn site -o -P daisy,docs-sites
Note: You don't have to build the complete site for every module every time. You can also go to a module, that is configured to provide docs, of your choice and build its docs only if this fits your needs.

Deploy the site locally

Deploy the site using the "localDocs" profile.

mvn site:deploy -o -P daisy,docs-sites,localDocs

If you want to checkin the local docs build to SVN in order to publish them, make sure that the profile above (localDocs) points to a local directory which is a checkout of our docs from SVN (http://svn.apache.org/repos/asf/cocoon/site/site/).

There is a guide with additional information about how to publish our docs.

Errors and Improvements? If you see any errors or potential improvements in this document please help us: View, Edit or comment on the latest development version (registration required).