Maven Shared Components

Improve the documentation concerning the archiver configuration

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: maven-archiver
  • Labels:
    None
  • Number of attachments :
    0

Description

Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
We have to improve this with a sample configuration containing all options.

Issue Links

is duplicated by

Improvement - An improvement or enhancement to an existing feature or task. MJAR-58 Update Jar Plugin Documentation (more examples for manifest customization)

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Dennis Lundberg added a comment -

I think that we should create documentation for maven-archiver in maven-archiver. Since it is used by several plugins it would be good to have these sample configurations in only one place.

Show
Dennis Lundberg added a comment - I think that we should create documentation for maven-archiver in maven-archiver. Since it is used by several plugins it would be good to have these sample configurations in only one place.
Hide
Permalink
Olivier Lamy added a comment -

Agree sounds a better place.

Show
Olivier Lamy added a comment - Agree sounds a better place.
Hide
Permalink
Dennis Lundberg added a comment -

I have some time off coming up soon, so I can help write some documentation.

Show
Dennis Lundberg added a comment - I have some time off coming up soon, so I can help write some documentation.
Hide
Permalink
Olivier Lamy added a comment -

Cool.
My idea was to add an index page in archiver with a full plugin configuration sample containing fields explanation.
Something like http://maven.apache.org/plugins/maven-jar-plugin/examples/manifest-customization.html but with all fields.
WDYT ?

Show
Olivier Lamy added a comment - Cool. My idea was to add an index page in archiver with a full plugin configuration sample containing fields explanation. Something like http://maven.apache.org/plugins/maven-jar-plugin/examples/manifest-customization.html but with all fields. WDYT ?
Hide
Permalink
Dennis Lundberg added a comment -

Examples are good, but I feel that they should explain concepts rather than details. Like the second example on the page you linked to. More of a "how do I" documentation than "what does this parameter do" documentation.

I think that the details of the fields belong in a reference section, like we have for mojos http://maven.apache.org/plugins/maven-jar-plugin/jar-mojo.html or for the pom http://maven.apache.org/ref/current/maven-model/maven.html

Show
Dennis Lundberg added a comment - Examples are good, but I feel that they should explain concepts rather than details. Like the second example on the page you linked to. More of a "how do I" documentation than "what does this parameter do" documentation. I think that the details of the fields belong in a reference section, like we have for mojos http://maven.apache.org/plugins/maven-jar-plugin/jar-mojo.html or for the pom http://maven.apache.org/ref/current/maven-model/maven.html
Hide
Permalink
Olivier Lamy added a comment -

some work started with rev 607354.

Show
Olivier Lamy added a comment - some work started with rev 607354.
Hide
Permalink
Olivier Lamy added a comment -

fix in rev 607477.

Show
Olivier Lamy added a comment - fix in rev 607477.
Hide
Permalink
Dennis Lundberg added a comment -

Copied docs from maven-jar-plugin, rewrote them and integrated them with the rest of the docs in r607846.

Show
Dennis Lundberg added a comment - Copied docs from maven-jar-plugin, rewrote them and integrated them with the rest of the docs in r607846.

People

  • Assignee:
    Olivier Lamy
    Reporter:
    Olivier Lamy
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: