About this documentation

This is the developer documentation for Sample: simple maven project.

Created by Meikel at Meikel (http://www.meikel.at).

It was generated at 2019-07-26 19:56.

In case of questions send email to meikel@meikel.at.

Prerequisites

  • Have Java SDK installed
  • Have Maven 3 installed
  • Create file %USERPROFILE%\.m2\settings.xml with following contents 
    <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
                      
  <localRepository>C:/m2repo</localRepository>
  
  <servers>
    <server>
      <id>website.projekte.meikel.at</id>
      <username>the-username</username>
      <password>the-password</password>
    </server>   
  </servers> 
</settings>

References

Create the distribution

mvn clean package

Create a new release

mvn release:prepare-with-pom release:perform

Running the distribution

  • Unzip the maven-sample-project-version-distribution.zip file
  • Execute the run.bat script

Logging configuration

Put a log4j.properties file in the working directory and configure as desired. If no such file exists the following default is used:





Configuration


Put a maven-sample-project.properties file in the working directory and configure as desired. If no such file exists the following defaults are used:








Create and view documentation


Run the following command then open a browser and navigate to http://localhost:8080/.




mvn clean site site:run




Deploy documentation to the website


Run the following command then open a browser and navigate to http://projekte.meikel.at/maven-simple-project and then click to the directory matching the version you're interested in, i.e. 0.0.2-SNAPSHOT.


The specs will be found under i.e. http://projekte.meikel.atl/maven-simple-project/0.0.2-SNAPSHOT/tralala location.




mvn clean site site:deploy