Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionA collection of blueprints for Confluence to create and work with documentation for Java projects. 
Doctypetopichide
Nameprojectdoc for Java Developers 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Categories
Name List
doctypecategory
names/ projectdoc / Doctype Add-on
propertyCategories
 

Tags
Tag List
namesDoctype Add-on, POM Import, Experimental
propertyTags
 
Iteration
Iteration
valuefinished
hide
Status
Status
colourGreen
titleAvailable
 

Atlassian Marketplacehttps://marketplace.atlassian.com/1215321hide
Bibuckethttps://bitbucket.org/smartics-de/smartics-projectdoc-confluence-space-javahide
Issue Managementhttps://www.smartics.eu/jira/projects/PDJAVADEV 
Sort Key000280hide
RequiresMaven Extensionhide
Column
Section
Column
width80%
Panel
titleColorwhite
titleBGColororange
titleInstall projectdoc for Java Developers!

Install projectdoc for Java Developers now and for free via

Atlassian Marketplace

Column
Document Properties Supplier
cssmeet
render-asdefinition-list
Requires projectdoc
Display Space Property
property-nameproject-version
 

Requires Maven Extension1.1 
Transclusion
documentDoctype Add-on Sources
idsJava Development

projectdoc-content-marker
hidetrue

Cheese

projectdoc-section
indextrue
idDescription
titleOverview

This extension provides a space blueprint to create a space based on a Maven POM. The POM information is added as Metadata documents and their information is made available as space properties. All metadata documents (currently it is only one that contains all POM information) are added as subpages to a Version document. This makes it easy to switch versions for the documentation of a space and its references to resources on remote servers (such as Nexus or Javadoc reports on a Maven site).

If developers add Topic documents of the Main type, these articles will automatically be listed under the documentation section. This section will be placed between the Overview and the References section once at least on such topic is defined.

Please note that this add-on is in beta status. We are experimenting with the integration of Maven artifacts and not everything is running as smoothly as you would expect from the final release.

We would be happy to receive your feedback about what you like most and would love to hear what features your would like to be improved!
projectdoc-boxtransclusion-cautionmacro
titledocumentMaven Extension Beta Status
idsContent

Section
titlePrerequisites

projectdoc for Java Developers requires the commercial PDAC1 and the free Maven Extension to be installed. It is recommended to also install the free Information Systems Extension.

The add-on also uses blueprints from the free Core Doctypes for projectdoc.

Please install the following add-ons on your Atlassian Confluence server:

Tip Box

Instructions on the configuration of the Maven Extension are described in the Installation section.

Section
Column
width50%
Panel
titleColorwhite
titleBGColororange
title1. Install projectdoc Toolbox

Install add-on now

Atlassian Marketplace

Column
width50%
Panel
titleColorwhite
titleBGColororange
title2. Install Extension for Maven

Install the free Extension for Maven

Atlassian Marketplace



Section
Column
width50%
Panel
titleColorwhite
titleBGColororange
title3. Install Information Systems Extension!

Install the free Information Systems Extension

Atlassian Marketplace

Column
width50%
Panel
titleColorwhite
titleBGColororange
title4. Install Core Doctypes!

Install the Core doctype add-on now and for free

Atlassian Marketplace

...

Section
titleResources

Here is a list of resources to find more information on documenting software projects and products with the PDAC1 and Maven.

Tour
render-as-definition-listtrue
replace-title-with-nametrue
TitleShort Description
Maven POM Import 
Maven Extension