Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: 2.0.2
    • Component/s: None
    • Labels:
      None
    1. MWAR-48-maven-war-plugin[draft4].patch
      14 kB
      Marvin King
    2. MWAR-48-maven-war-plugin[draft4-1].patch
      3 kB
      Marvin King
    3. MWAR-48-maven-war-plugin[draft4-1-1].patch
      13 kB
      franz allan valencia see

      Issue Links

        Activity

        Hide
        Brett Porter added a comment -

        I have applied this, but would like further revision:

        • need an index.html
        • introduction should be usage.html
        • replace 'm2' with 'mvn' in examples
        • incorrect formatting of <<<packaging>>>
        • version of 1.0-SNAPSHOT, not 0.0 which is not a very sensible example
        • instead of talking about modes, talk about "use cases":
        • WAR as a packaging type
        • building a WAR from the command line (note that they need to have previously run package to compile classes, etc)
        • building an exploded WAR from the command line (note that they need to have previously run package to compile classes, etc)
        • building a WAR in place from the command line
        • remove defaults at bottom of page - the reference page lists these (and will be improved later)
        • better explanatory text at the top (the part about it being error prone is irrelevant - nobody does things by hand in Maven)
        • use <code style> for things like pom.xml, WEB-INF/lib, target/..., etc
        • remove the example for putting inplace in the pom, it makes no sense
        • for the directory diagrams, consider using 'tree': available for cygwin here: http://lassauge.free.fr/cygwin/release/
        • be careful with boilerplating documents. Some of these have inconsistencies that have been copy+pasted.
        • the example links are broken
        • choose shorter, more concise names for the examples
        • FAQ should be a normal menu item, not a header.
        Show
        Brett Porter added a comment - I have applied this, but would like further revision: need an index.html introduction should be usage.html replace 'm2' with 'mvn' in examples incorrect formatting of <<<packaging>>> version of 1.0-SNAPSHOT, not 0.0 which is not a very sensible example instead of talking about modes, talk about "use cases": WAR as a packaging type building a WAR from the command line (note that they need to have previously run package to compile classes, etc) building an exploded WAR from the command line (note that they need to have previously run package to compile classes, etc) building a WAR in place from the command line remove defaults at bottom of page - the reference page lists these (and will be improved later) better explanatory text at the top (the part about it being error prone is irrelevant - nobody does things by hand in Maven) use <code style> for things like pom.xml, WEB-INF/lib, target/..., etc remove the example for putting inplace in the pom, it makes no sense for the directory diagrams, consider using 'tree': available for cygwin here: http://lassauge.free.fr/cygwin/release/ be careful with boilerplating documents. Some of these have inconsistencies that have been copy+pasted. the example links are broken choose shorter, more concise names for the examples FAQ should be a normal menu item, not a header.
        Hide
        Marvin King added a comment -



        rewriting...

        Show
        Marvin King added a comment - rewriting...
        Hide
        Brett Porter added a comment -

        please ensure webResources are documented, too

        Show
        Brett Porter added a comment - please ensure webResources are documented, too
        Hide
        Marvin King added a comment -


        done

        Show
        Marvin King added a comment - done
        Hide
        Marvin King added a comment -



        will add a new page under configuration for manifest customization

        Show
        Marvin King added a comment - will add a new page under configuration for manifest customization
        Hide
        Marvin King added a comment -


        for review

        Show
        Marvin King added a comment - for review
        Hide
        Brett Porter added a comment -

        Applied.

        still needed:

        • need an index.html that links to the standard usage, and additional use cases, and paste in the goal references from plugin-info (we should generate that differently later)
        • rename HOWTO to Usage.
        • comment out the FAQ in the nav since it's not used yet
        • the "war:exploded" and "war:inplace" use cases don't appear to be linked in (they should be as
          • building a WAR from the command line (note that they need to have previously run package to compile classes, etc)
          • building an exploded WAR from the command line (note that they need to have previously run package to compile classes, etc)
          • building a WAR in place from the command line
        • use example.com, not ideal.com (that's a real domain)
        • rename advanced configuration to Examples
        • jetty6: I think this can be under the main examples menu

        usage:

        • give more explanation of what is being done in the use case (same could be applied to other docs)
        • the links at the bottom make more sense on the index page (or via pages like examples/war-manifest-guide.html that you already have)
        Show
        Brett Porter added a comment - Applied. still needed: need an index.html that links to the standard usage, and additional use cases, and paste in the goal references from plugin-info (we should generate that differently later) rename HOWTO to Usage. comment out the FAQ in the nav since it's not used yet the "war:exploded" and "war:inplace" use cases don't appear to be linked in (they should be as building a WAR from the command line (note that they need to have previously run package to compile classes, etc) building an exploded WAR from the command line (note that they need to have previously run package to compile classes, etc) building a WAR in place from the command line use example.com, not ideal.com (that's a real domain) rename advanced configuration to Examples jetty6: I think this can be under the main examples menu usage: give more explanation of what is being done in the use case (same could be applied to other docs) the links at the bottom make more sense on the index page (or via pages like examples/war-manifest-guide.html that you already have)
        Hide
        Brett Porter added a comment -

        that's meant to just be a : above, not a smiley...

        Show
        Brett Porter added a comment - that's meant to just be a : above, not a smiley...
        Hide
        Brett Porter added a comment -

        see Javadoc's overview for a good example of what the index page should be.

        Show
        Brett Porter added a comment - see Javadoc's overview for a good example of what the index page should be.
        Hide
        Marvin King added a comment -
        • restructuring
        Show
        Marvin King added a comment - restructuring
        Hide
        Marvin King added a comment -



        draft4 for review

        Show
        Marvin King added a comment - draft4 for review
        Hide
        Brett Porter added a comment -

        applied, but:

        -still missing index.html

        • "introduction" links to a missing overview.html (should be index.html given above)
        • on usage: "mvn:exploded" is used instead of "war:exploded" and "war:inplace".
        • in external web sources you say "Warning : Overlayed war files will overwrite the files in your war.", but this shouldn't happen (there are tests to prove it

        thanks

        Show
        Brett Porter added a comment - applied, but: -still missing index.html "introduction" links to a missing overview.html (should be index.html given above) on usage: "mvn:exploded" is used instead of "war:exploded" and "war:inplace". in external web sources you say "Warning : Overlayed war files will overwrite the files in your war.", but this shouldn't happen (there are tests to prove it thanks
        Hide
        Marvin King added a comment -

        i missed the index.apt and modify the mvn:<goal> to war:<goal>.
        I'll remove that note about the overlay war files overwrriting the existing war files. =) the recent fix makes this obsolete.

        revising for draft4-1

        Show
        Marvin King added a comment - i missed the index.apt and modify the mvn:<goal> to war:<goal>. I'll remove that note about the overlay war files overwrriting the existing war files. =) the recent fix makes this obsolete. revising for draft4-1
        Hide
        Marvin King added a comment -



        for review draft4-1

        Show
        Marvin King added a comment - for review draft4-1
        Hide
        Brett Porter added a comment -

        applied, thanks!

        Show
        Brett Porter added a comment - applied, thanks!
        Hide
        Franz Allan Valencia See added a comment -

        Changes with MWAR-48-maven-war-plugin[draft4-1-1].patch

        In index.html
        Added the example "Rapid testing using jetty6"
        Added the example "Creating skinny wars"

        In *.apt
        Reformatted to follow the Maven Plugin Documentation Guidelines in [1]

        [1] http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation

        Show
        Franz Allan Valencia See added a comment - Changes with MWAR-48 -maven-war-plugin [draft4-1-1] .patch In index.html Added the example "Rapid testing using jetty6" Added the example "Creating skinny wars" In *.apt Reformatted to follow the Maven Plugin Documentation Guidelines in [1] [1] http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation
        Hide
        Siveton Vincent added a comment -

        Applied.
        Waiting for review. Staging site is available at:
        http://people.apache.org/~vsiveton/maven-war-plugin/

        Show
        Siveton Vincent added a comment - Applied. Waiting for review. Staging site is available at: http://people.apache.org/~vsiveton/maven-war-plugin/
        Hide
        maartenbrugman added a comment -

        I'm using the war plug-in.
        Seems like the updated documentation is nearly finished.
        It would help people like me a lot if this were published, e.g. I spent several hours figuring out how to exclude an item from the WAR, in the end I found out by reading the source code. Now I see that it is described in the updated docs.
        So is this ready for publication? I understand that we are all busy, consider this just a polite question.

        Show
        maartenbrugman added a comment - I'm using the war plug-in. Seems like the updated documentation is nearly finished. It would help people like me a lot if this were published, e.g. I spent several hours figuring out how to exclude an item from the WAR, in the end I found out by reading the source code. Now I see that it is described in the updated docs. So is this ready for publication? I understand that we are all busy, consider this just a polite question.
        Hide
        Ernesto S. Tolentino Jr. added a comment -

        Just wondering why this was reopened? Was there any problem with the current documentation or is this just waiting for the plugin documentation to be released?

        Show
        Ernesto S. Tolentino Jr. added a comment - Just wondering why this was reopened? Was there any problem with the current documentation or is this just waiting for the plugin documentation to be released?
        Hide
        Brett Porter added a comment -

        it was reopened for the additional patch, but not closed after being applied

        Show
        Brett Porter added a comment - it was reopened for the additional patch, but not closed after being applied

          People

          • Assignee:
            Unassigned
            Reporter:
            Marvin King
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Due:
              Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - Not Specified
              Not Specified
              Remaining:
              Remaining Estimate - 0h
              0h
              Logged:
              Time Spent - 37.5h
              37.5h

                Development