projectdoc Toolbox

 

 

 

Add-on to extend projectdoc for Confluence with Maven Tools.

Parent
Categories
Version
1.1.0
projectdoc Toolbox
1.16

Available on the Atlassian Marketplace

Contents

The extension allows to create projectdoc documents based on Maven POMs.

The POM information is imported either via the GAV reference or by providing the URL to a POM file.

projectdoc downloads the artifacts from the configured Nexus artifact repository and creates a space based on that information.

 

Installation

Deploy Artifacts

To create spaces for Java or Maven projects, follow the following steps.

 

Prior to version 1.11 of the projectdoc Toolbox the two extensions are part of the projectdoc Toolbox add-on.

The following add-ons are available on the Atlassian Marketplace:

  1. Install the projectdoc Toolbox (commercial)
  2. Install the Maven Extension (free, available soon)
  3. Optional: Install the Information Systems Extension (free, available soon)
  4. Install the Core Doctypes Add-on (free)

Then install either of the two doctype add-ons:

These add-ons are currently available on Bitbucket only:

  1. Doctypes for Maven Developers Add-on (free)
  2. Doctypes for Java Developers Add-on (free)

Configuration

To start your documentation, follow these steps:

  1. Configure the infrastructure for Maven
  2. Create a space with a Space Blueprint provided by one of the doctype add-ons

Get started

To get started, use the following information:

  1. projectdoc Introduction
  2. Introduction for projectdoc Users
  3. Hands-on Tutorial

Doctype Add-ons

The following doctype add-ons are based on the Maven Extension.

Name Short Description
Provides a basic set of doctypes to create agile documentation.
A collection of blueprints for Confluence to create and work with documentation for Java projects.
A collection of blueprints for Confluence to create and work with documentation for Maven projects.

 

All examples shown are based on one of these doctype add-ons. The Maven Extension does not provide any macros, doctype or space blueprints.

Subordinate Topics

Maven POM Import
Import project information from Maven POM files. Provides information about required configuration to get this import running.