Functioning and Deployment

In fact, three applications play a role when generating Japedo documentation in a protected environment. The orchestrating application is either the japedoGenerator web application itself or an application where the japedoGenerator library is contained. It exposes the REST web services to control the process of Japedo documentation generation and executes and triggers everything that is necessary.

The executing application is not deployed but the application's project is cloned from git. The pom.xml must contain a profile where the japedo-maven-plugin is configured. The japedo.jar executable must either be available in the executing application's project or must be accessible in the protected environment. The orchestrating application executes maven with the japedo:generate goal of the plugin.

Finally, the target application and database is the application for which the documentation will be generated. This application is not installed in the protected environment but downloaded from a repository. The generated documentation is then pushed into a Git repository where it can be published as Gitlab pages.

Orchestrating, executing and target application could be three different applications. They could also be the same application, the first installed and deployed, the second cloned as Maven project from Git and the third as downloaded sources from the repository.