ForgeRock Doc Maven Plugin

Most core documentation sources for the open-source projects led by ForgeRock are DocBook XML and Asciidoc text files.

The open-source projects led by ForgeRock use Apache Maven for builds and to maintain project dependencies.

The forgerock-doc-maven-plugin and its dependencies make it possible to process core documentation sources and to build draft docs with Maven.

The plugin started out as a wrapper for the docbkx-tools plugin, which drives the DocBook XSL stylesheets in Maven builds. It has since grown to perform a variety of pre-processing tasks.

Get Started

The forgerock-doc-maven-plugin is available from ForgeRock’s Maven repository:

  <properties>
    <mavenRepoSnapshots>https://maven.forgerock.org/repo/snapshots</mavenRepoSnapshots>
    <mavenRepoReleases>https://maven.forgerock.org/repo/releases</mavenRepoReleases>
    <doc-tools.version>some.version.number</doc-tools.version>
  </properties>
  
  <repositories>
    <repository>
      <id>forgerock-staging-repository</id>
      <name>ForgeRock Release Repository</name>
      <url>https://maven.forgerock.org/repo/releases</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
    <repository>
      <id>forgerock-snapshots-repository</id>
      <name>ForgeRock Snapshot Repository</name>
      <url>https://maven.forgerock.org/repo/snapshots</url>
      <releases>
        <enabled>false</enabled>
      </releases>
    </repository>
  </repositories>

  <build>
    <plugins>
      <plugin>
        <groupId>org.forgerock.commons</groupId>
        <artifactId>forgerock-doc-maven-plugin</artifactId>
        <version>${doc-tools.version}</version>
      </plugin>
    </plugins>
  </build>

Build Your Own

Build and run basic tests:

mvn -Pprecommit install

Also run integration tests:

mvn -Pprecommit,it install

Find Documentation

Find the documentation for the version you use with the source code at https://stash.forgerock.org/projects/DOCS/repos/forgerock-doc-maven-plugin.

See both the README version.md and Release Notes version.md files.

Contribute

You can contribute to the plugin in several ways:


The contents of this file are subject to the terms of the Common Development and Distribution License (the License). You may not use this file except in compliance with the License.

You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the specific language governing permission and limitations under the License.

When distributing Covered Software, include this CDDL Header Notice in each file and include the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL Header, with the fields enclosed by brackets [] replaced by your own identifying information: “Portions copyright [year] [name of copyright owner]”.

Copyright 2016 ForgeRock AS.