Role in the IKE Ecosystem

This project is the canonical template for an IKE library that ships both code and docs. The companion project doc-example^[1] is the template for a doc-only deliverable. Together they cover the two common shapes of IKE consumer:

For the workspace-aggregator template (one repo orchestrating multiple consumers via ws:* goals), see ike-example-ws^[2].

Release Cascade Position

ike-tooling -> ike-docs -> ike-platform -> [example-project, doc-example] -> ike-example-ws

example-project releases after ike-platform (whose ike-parent this project consumes) and after ike-docs (whose ike-doc-maven-plugin is declared as a regular managed plugin in ike-parent via 43; the documentation pipeline activates through a profile when src/docs/asciidoc/ exists). Earlier revisions used the <extensions>true</extensions> mechanism to register a custom <packaging>ike-doc</packaging> type at literal versions; that machinery was retired in ike-issues#321^[3] in favor of a classifier-canonical doc shape (<classifier>adoc</classifier><type>zip</type>).

Project Structure

example-project/
├── pom.xml                              (1)
├── src/
│   ├── main/java/                       (2)
│   ├── test/java/                       (3)
│   ├── docs/asciidoc/                   (4)
│   │   ├── index.adoc                   (5)
│   │   └── chapters/
│   └── site/                            (6)
│       ├── asciidoc/index.adoc
│       ├── resources/css/site.css
│       └── site.xml
└── target/
    ├── example-project-1-SNAPSHOT.jar   (7)
    └── generated-docs/
        ├── html/                        (8)
        ├── pdf-prawn/                   (9)
        └── pdf-fop/                     (10)

Build Commands

# Compile + test + HTML docs (default):
mvn clean verify

# With Prawn PDF:
mvn clean verify -Dike.pdf.prawn

# With FOP PDF:
mvn clean verify -Dike.pdf.fop

# All renderers:
mvn clean verify -Dike.pdf.prawn -Dike.pdf.fop

# Generate this site (Maven Site Plugin):
mvn site

Inheritance Pattern

example-project inherits ike-parent directly:

<parent>
    <groupId>network.ike.platform</groupId>
    <artifactId>ike-parent</artifactId>
    <version>6</version>
</parent>

After inheriting, the project gets — for free — Java 25 compilation, GPG signing via Bouncy Castle, JaCoCo coverage, the AsciiDoc documentation pipeline, and dependency-version management for the IKE ecosystem. ike-maven-plugin and ike-doc-maven-plugin are declared as ordinary managed plugins (no extensions=true, post-#321) and resolve via property indirection (185, 43).

The doc pipeline activates automatically when src/docs/asciidoc/ exists. No <plugins> block in this project’s POM is needed for documentation — the parent profile handles it.

What to Copy When Starting a New Project

When creating a new IKE library, copy the following from this template:

Not published to Maven Central

example-project is a reference template, not a library. Its releases are tagged on GitHub and deployed to the IKE Nexus, but it is deliberately not published to Maven Central — nothing should ever declare a dependency on it. You consume this project by reading it and copying its structure into a project of your own. The IKE foundation (ike-base-parent, ike-tooling, ike-docs, ike-platform) is the part published to Central and meant to be inherited; see the IKE Network landing page^[4] for the foundation/examples split.

Resources