Maven Archetype

Update plugin documentation

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Critical Critical
  • Resolution: Unresolved
  • Affects Version/s: 2.0-alpha-1
  • Fix Version/s: None
  • Component/s: Documentation
  • Labels:
    None
  • Number of attachments :
    0

Description

The archetypeng documentation should be improved to reach the current code and pass the dockk check

Activity

Hide
Raphaël Piéroni added a comment -

Changing issues to be fixed at next release

Show
Raphaël Piéroni added a comment - Changing issues to be fixed at next release
Hide
Wendy Smoak added a comment -

I added the docck plugin with the same profile that the main set of plugins uses. 'mvn site -PciProfile' will enable it.

The first two problems it reported were due to the directory name not matching the artifactId. I had to add project and scm urls to make it happy. We may want to rename the directory in svn.

Here is what remains according to docck:

o Maven Archetype Plugin (7 errors, 0 warnings)
[ERROR] Parameter: 'localRepository' in mojo: 'create-from-project' is missing a description.
[ERROR] Parameter: 'outputDirectory' in mojo: 'create-from-project' is missing a description.
[ERROR] Parameter: 'packageName' in mojo: 'create-from-project' is missing a description.
[ERROR] Parameter: 'testMode' in mojo: 'create-from-project' is missing a description.
[ERROR] Parameter: 'basedir' in mojo: 'create' is missing a description.
[ERROR] Mojo: 'jar' is missing a description.
[ERROR] There is no 'faq' file in your site directory (in apt|fml|html|xml format).

Show
Wendy Smoak added a comment - I added the docck plugin with the same profile that the main set of plugins uses. 'mvn site -PciProfile' will enable it. The first two problems it reported were due to the directory name not matching the artifactId. I had to add project and scm urls to make it happy. We may want to rename the directory in svn. Here is what remains according to docck: o Maven Archetype Plugin (7 errors, 0 warnings) [ERROR] Parameter: 'localRepository' in mojo: 'create-from-project' is missing a description. [ERROR] Parameter: 'outputDirectory' in mojo: 'create-from-project' is missing a description. [ERROR] Parameter: 'packageName' in mojo: 'create-from-project' is missing a description. [ERROR] Parameter: 'testMode' in mojo: 'create-from-project' is missing a description. [ERROR] Parameter: 'basedir' in mojo: 'create' is missing a description. [ERROR] Mojo: 'jar' is missing a description. [ERROR] There is no 'faq' file in your site directory (in apt|fml|html|xml format).

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated: