Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

mod_cluster documentation 2.0

Welcome to the new mod_cluster live documentation!


How can I contribute?

  • Get familiar with AsciiDoc.

  • Open and locate section you want to contribute to.

  • Click 'Help us improve this section on GitHub!' at the top of each section.

  • If using an IDE, fork and clone the repository locally and navigate to docs/src/main/asciidoc/ directory.

  • Once finished editing, click 'Propose changes' which will open a new pull request.

  • Pull request will be quickly reviewed by mod_cluster contributors, merged, and changes will be live almost instantly!


  • Documentation changes infrequently. To minimize the maintenance cost of multiple documentation versions, use wording similar to "Since version 1.3" to describe behavior changes across versions.

  • Commit messages: you can describe changes you have done, or you could leave the default GitHub message which will just say "Update section.adoc".

  • Use shorter lines to make rebasing and editing from the web slightly easier.

  • Documentation always resides in main branch of the upstream (modcluster/ repository.

Building locally

The build uses Apache Maven with mvn package:

[rhusar@primitivo]$ mvn package
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO] mod_cluster docs (parent)                                          [pom]
[INFO] mod_cluster docs: Documentation                                    [pom]
[INFO] -----------< org.jboss.mod_cluster:mod_cluster-docs-parent >------------
[INFO] Building mod_cluster docs (parent) 2.0.0.Alpha1-SNAPSHOT           [1/2]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] --- maven-enforcer-plugin:3.0.0-M2:enforce (enforce-java-version) @ mod_cluster-docs-parent ---
[INFO] --- maven-enforcer-plugin:3.0.0-M2:enforce (enforce-maven-version) @ mod_cluster-docs-parent ---
[INFO] --- maven-enforcer-plugin:3.0.0-M2:enforce (enforce-https-repositories) @ mod_cluster-docs-parent ---
[INFO] --- buildnumber-maven-plugin:1.4:create (get-scm-revision) @ mod_cluster-docs-parent ---
[INFO] Executing: /bin/sh -c cd '/Users/rhusar/git/' && 'git' 'rev-parse' '--verify' 'HEAD'
[INFO] Working directory: /Users/rhusar/git/
[INFO] Storing buildNumber: 86586ad1ac5dbdb6b7995d387fe172135d1716d3 at timestamp: 1629720283364
[INFO] Storing buildScmBranch: main
[INFO] --- maven-source-plugin:3.0.1:jar-no-fork (attach-sources) @ mod_cluster-docs-parent ---
[INFO] ---------------< org.jboss.mod_cluster:mod_cluster-docs >---------------
[INFO] Building mod_cluster docs: Documentation 2.0.0.Alpha1-SNAPSHOT     [2/2]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] --- maven-enforcer-plugin:3.0.0-M2:enforce (enforce-java-version) @ mod_cluster-docs ---
[INFO] --- maven-enforcer-plugin:3.0.0-M2:enforce (enforce-maven-version) @ mod_cluster-docs ---
[INFO] --- maven-enforcer-plugin:3.0.0-M2:enforce (enforce-https-repositories) @ mod_cluster-docs ---
[INFO] --- buildnumber-maven-plugin:1.4:create (get-scm-revision) @ mod_cluster-docs ---
[INFO] --- asciidoctor-maven-plugin:1.6.0:process-asciidoc (pdf) @ mod_cluster-docs ---
[INFO] AsciiDoc processing is skipped.
[INFO] --- maven-source-plugin:3.0.1:jar-no-fork (attach-sources) @ mod_cluster-docs ---
[INFO] --- asciidoctor-maven-plugin:1.6.0:process-asciidoc (output-html) @ mod_cluster-docs ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 5 resources to images
[INFO] Copying 1140 resources to .
[INFO] Rendered /Users/rhusar/git/
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for mod_cluster docs (parent) 2.0.0.Alpha1-SNAPSHOT:
[INFO] mod_cluster docs (parent) .......................... SUCCESS [  0.549 s]
[INFO] mod_cluster docs: Documentation .................... SUCCESS [  3.608 s]
[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.255 s
[INFO] Finished at: 2021-08-23T14:04:47+02:00
[INFO] ------------------------------------------------------------------------

Resulting files are located in the docs/target/generated-docs/ directory.

Inner Workings

How does it work?

  1. Changes are proposed in a pull request for repository.

  2. Changes are committed (merged) by a mod_cluster committer to the main branch.

  3. GitHub Actions detects the changes and runs a maven build, pushes the changes into gh-pages branch of the upstream repository.

  4. GitHub Pages picks up the changes and deploys the website.

CNAME record is configured on the website pointing to GitHub servers.


mod_cluster documentation sources and hosting




No releases published


No packages published