Child pages
  • User Documentation for Maven Plugin

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionProvide a standard documentation for users of a plugin for Maven. 
Doctypebusiness-use-casehide
NameUser Documentation for Maven Plugin 
Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
propertyAudience
 
Subject
Name List
doctypesubject
propertySubject
 
Categories

Name List
doctypecategory
names/ Product Documentation
space-keys@all
propertyCategories

 
Tags
Tag List
propertyTags
 
Iteration

Iteration
valuefocused

hide
Sort Keyhide
Section
titleDescription
 
Section
show-titlefalse
titleSummary

Teams whose builds depend on Maven and that use automation heavily typically end up in writing their own plugins for Maven. Although these plugins are often only released for internal use, developers who employ these plugins need to have access to proper documentation. Maven provides the Maven Plugin Plugin to create as much meaningful documentation automatically from the source code. While it is easy to add howtos and tutorials - which are typically not generated automatically - with the use of the Maven Site Plugin, having these documents as part of the Confluence collaboration platform often makes it easier to apply changes and add additional information off-sync with the plugin's release cycle. Having this information in Confluence also makes it easier for non-programmers to add valuable information.

Caution Box
titleExperimental Add-on!

The projectdoc for Maven Developers Add-on is available on the Atlassian Marketplace and on Bitbucket. It is still considered to be experimental. So expect to encounter some rough edges.

Please get in touch if you have suggestions for improving the add-on or fork it on Bitbucket!

Example for a Maven Plugin Documentation with Confluence and the projectdoc ToolboxThis approach does require to create a Maven Site with all reports and to link to or transclude from this information. The Information Systems Extension provides macros to access information from remote servers.

Example Box
titleLive Examples

Here are some examples using this tool set.

Display Table
selectSmall Plugin Logo+|, Short Description
space-keys@all
where$<Tags>=[Plugin for Maven]
header-translationsSmall Plugin Logo=Plugin
suppress-table-headingtrue

...

Section
titleResources
Section
titleInformation Material

The following list of resources provides background information on creating and working documentation for Java librariesMaven plugins based on the PDAC1 for Confluence..

Tour
header-translationsName=Resource, Doctype=Type
replace-title-with-nametrue
Section
titleDoctypes

The following doctypes (blueprints based on the PDAC1) provided page blueprints to create documentation for a Java library.

Tour
header-translationsName=Resource, Doctype=Type
replace-title-with-nametrue
TitleShort DescriptionCategories
Property  

Metadata  

Version  

Artifact  

Code  

Interface  

Section
titleMacros

The following macros of the PDAC1 support creating or working with documentation for a Java library.

Tour
header-translationsName=Resource, Doctype=Type
replace-title-with-nametrue
Section
titleRelated Use Cases
Tour
header-translationsName=Resource, Doctype=Type
replace-title-with-nametrue