Information System Model Documentation Maven Plugin

Maven plugin for automatically generating documentation from Information System models.

Table of contents

• Overview
• Configuration
• Parameters
• Documentation
• Changelog
• Authors
• How to Cite
• License
• About gCube
• Funding

Overview

This plugin inspects Information System Model definitions and automatically generates documentation in Markdown (md) or HTML (html) formats during the Maven build lifecycle.

The plugin executes inside an isolated URLClassLoader built from the host project's compile classpath, dynamically discovering and validating registered model types via RegistrationProvider.

Configuration

To generate documentation during builds (immediately after compilation), add the plugin to the <build><plugins> section of your model component's pom.xml (e.g. gcube-model):

<plugin>
    <groupId>org.gcube.information-system</groupId>
    <artifactId>information-system-model-documentation-maven-plugin</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <configuration>
        <registrationProviderClass>org.gcube.resourcemanagement.model.impl.GCubeModelRegistrationProvider</registrationProviderClass>
        <outputDirectory>${project.basedir}/documentation</outputDirectory>
        <format>md</format>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>generate-docs</goal>
            </goals>
            <phase>process-classes</phase>
        </execution>
    </executions>
</plugin>

Parameters

Parameter	Type	Default	Description
registrationProviderClass	String	(optional)	Fully qualified class name of the RegistrationProvider to document (e.g. org.gcube.resourcemanagement.model.impl.GCubeModelRegistrationProvider). If omitted, all providers discovered via ServiceLoader on the project compile classpath are used.
outputDirectory	File	${project.basedir}/documentation	Target directory where the generated documentation files will be placed.
format	String	md	Target template format (md or html).

Documentation

For detailed documentation, please visit: https://code-repo.d4science.org/gCubeSystem/information-system-model-documentation-maven-plugin

Changelog

See CHANGELOG.md.

Authors

• Luca Frosini as Researcher, Architect, Maintainer, Developer (ORCID)
  • Istituto di Scienza e Tecnologie dell'Informazione 'A. Faedo', Consiglio Nazionale delle Ricerche, Pisa, Italy
  • D4Science Infrastructure, Pisa, Italy

How to Cite

If you use this software, please cite it using the metadata in CITATION.cff

License

This project is licensed under the terms specified in the LICENSE.md file.

About gCube

This software is part of the gCube Framework: an open-source software toolkit used for building and operating Hybrid Data Infrastructures enabling the dynamic deployment of Virtual Research Environments by favouring the realisation of reuse oriented policies. The gCube Framework supports the development and operation of the D4Science Infrastructure.

Funding

See FUNDING.md