How to Build the Axis2 Project's Website

Installing Maven

The Axis2 website build system depends on Maven. The build requires Maven 3.6.0 or later and JDK 17 through 25. To install Maven, download the distribution and follow the instructions in the documentation. Make sure you add the MAVEN_HOME/bin directory to the path.

Checking out Axis2

Clone the latest source from GitHub: git clone https://github.com/apache/axis-axis2-java-core.git (see Developing Apache Axis2).

Building the Site

During maven releases site should have been generated on target/site directory and no special action required. Further release process guide describes necessary steps to update Axis2 site with your new modifications.

In case if you want to generate site only you could run mvn site on root project of your local copy.

FAQ

  1. How can I update a document in the site ?
    The documents are under the src/site folder: XDoc pages in src/site/xdoc, Markdown pages in src/site/markdown, APT pages in src/site/apt and the FAQ in src/site/fml. Change the relevant file and run mvn site. The new site will be available under target/site.
  2. How can I add a new document?
    Add the new document under the matching src/site folder. If it needs a menu entry, add a link to it in src/site/site.xml (most documentation pages are linked from src/site/xdoc/docs/toc.xml instead). Re-generate the site.
    Please make sure you have not included any of the illegal characters and your document should be well formed.