Maven Shared Components
  1. Maven Shared Components
  2. MSHARED-44

Improve the documentation concerning the archiver configuration

    Details

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

      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

          Activity

          Olivier Lamy (*$^¨%`£) created issue -
          Hide
          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.
          Olivier Lamy (*$^¨%`£) made changes -
          Field Original Value New Value
          Fix Version/s 2.2 [ 12878 ]
          Key MJAR-93 MNG-3329
          Affects Version/s 2.1 [ 12241 ]
          Fix Version/s Reviewed Pending Version Assignment [ 13555 ]
          Affects Version/s Shared Components [ 13561 ]
          Project Maven 2.x Jar Plugin [ 11137 ] Maven 2 [ 10500 ]
          Hide
          Olivier Lamy (*$^¨%`£) added a comment -

          Agree sounds a better place.

          Show
          Olivier Lamy (*$^¨%`£) added a comment - Agree sounds a better place.
          Olivier Lamy (*$^¨%`£) made changes -
          Component/s maven-archiver [ 11520 ]
          Hide
          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
          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 ?
          Olivier Lamy (*$^¨%`£) made changes -
          Link This issue is duplicated by MJAR-58 [ MJAR-58 ]
          Hide
          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
          Olivier Lamy (*$^¨%`£) added a comment -

          some work started with rev 607354.

          Show
          Olivier Lamy (*$^¨%`£) added a comment - some work started with rev 607354.
          Olivier Lamy (*$^¨%`£) made changes -
          Assignee Olivier Lamy [ olamy ]
          Hide
          Olivier Lamy (*$^¨%`£) added a comment -

          fix in rev 607477.

          Show
          Olivier Lamy (*$^¨%`£) added a comment - fix in rev 607477.
          Olivier Lamy (*$^¨%`£) made changes -
          Status Open [ 1 ] Closed [ 6 ]
          Resolution Fixed [ 1 ]
          Assignee Olivier Lamy [ olamy ]
          Hide
          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.
          Brett Porter made changes -
          Key MNG-3329 MSHARED-44
          Component/s maven-archiver [ 11520 ]
          Project Maven 2 [ 10500 ] Maven Shared Components [ 11761 ]
          Component/s maven-archiver [ 13268 ]
          Fix Version/s Reviewed Pending Version Assignment [ 13555 ]
          Mark Thomas made changes -
          Project Import Sun Apr 05 13:14:21 UTC 2015 [ 1428239661755 ]
          Mark Thomas made changes -
          Workflow jira [ 12726037 ] Default workflow, editable Closed status [ 12764557 ]
          Mark Thomas made changes -
          Project Import Mon Apr 06 01:15:59 UTC 2015 [ 1428282959282 ]
          Mark Thomas made changes -
          Workflow jira [ 12963900 ] Default workflow, editable Closed status [ 13000274 ]
          Transition Time In Source Status Execution Times Last Executer Last Execution Date
          Open Open Closed Closed
          10d 13h 7m 1 Olivier Lamy (*$^¨%`£) 29/Dec/07 15:36

            People

            • Assignee:
              Olivier Lamy (*$^¨%`£)
              Reporter:
              Olivier Lamy (*$^¨%`£)
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development