Maven Archetype
  1. Maven Archetype
  2. ARCHETYPE-45

Revise and review plugin documentation

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Number of attachments :
      3
    1. ARCHETYPE-45-maven-archetype-plugin.patch
      25 kB
      Franz Allan Valencia See
    2. ARCHETYPE-45-maven-archetype-plugin.patch
      40 kB
      Franz Allan Valencia See
    3. ARCHETYPE-45-maven-archetype-plugin-3.patch
      12 kB
      Franz Allan Valencia See

      Issue Links

        Activity

        Hide
        Franz Allan Valencia See added a comment -

        Made maven-archetype-plugin pass the document check for plugins (docck:plugin)

        Show
        Franz Allan Valencia See added a comment - Made maven-archetype-plugin pass the document check for plugins (docck:plugin)
        Hide
        Maria Odea Ching added a comment -

        Patch applied. Thanks

        Show
        Maria Odea Ching added a comment - Patch applied. Thanks
        Hide
        Maria Odea Ching added a comment -

        A staging site for the plugin docs can be accessed at http://people.apache.org/~oching/maven-archetype-plugin.

        Show
        Maria Odea Ching added a comment - A staging site for the plugin docs can be accessed at http://people.apache.org/~oching/maven-archetype-plugin .
        Hide
        Franz Allan Valencia See added a comment -

        PATCH: ARCHETYPE-45-maven-archetype-plugin.patch

        In the whole docu
        Applied monospacing font format on all commands, goals, parameters, and texts (tags, values, urls).
        changed all instances of "work in progress" to "currently under development"
        changed all instances of "proect" and projecct" to "project"

        In MavenArchetypeMojo.java
        changed "Once the archetype is retrieve it is process " to "Once the archetype is retrieved, it is then processed "

        In usage.html
        removed "The Archetype Plugin has two goals: create and create-from-project."
        included more information regarding the other parameters of the "create" goal and their defaults
        elaborated on how a specific archetype is chosen by the "create" goal

        In index.html
        changed "Once the archetype is retrieve it is process " to "Once the archetype is retrieved, it is then processed "
        changed "against a st of user" to "against a set of user"
        changed "Resources Plugin" to "Archetype Plugin"
        changed "Javadoc Plugin" to "Archetype Plugin"

        In mojo.html
        changed "ues" to "use"

        In remote-repositories.html
        changed "-D expression" to "property / parameter"

        In site.html
        included more info regarding the APT Format, and provided a link towards the APT Format Guide.

        Unapplied Comment:
        In usage.html
        changing of "specific directory structure" to "maven recommended directory structure"
        ...this was not applied because the directory structure i am referring to is the directory structure created by maven-archetype-plugin. And it does not necessarily mean that the directory structure produced by the plugin would follow maven's recommended directory structure.

        Show
        Franz Allan Valencia See added a comment - PATCH: ARCHETYPE-45 -maven-archetype-plugin.patch In the whole docu Applied monospacing font format on all commands, goals, parameters, and texts (tags, values, urls). changed all instances of "work in progress" to "currently under development" changed all instances of "proect" and projecct" to "project" In MavenArchetypeMojo.java changed "Once the archetype is retrieve it is process " to "Once the archetype is retrieved, it is then processed " In usage.html removed "The Archetype Plugin has two goals: create and create-from-project." included more information regarding the other parameters of the "create" goal and their defaults elaborated on how a specific archetype is chosen by the "create" goal In index.html changed "Once the archetype is retrieve it is process " to "Once the archetype is retrieved, it is then processed " changed "against a st of user" to "against a set of user" changed "Resources Plugin" to "Archetype Plugin" changed "Javadoc Plugin" to "Archetype Plugin" In mojo.html changed "ues" to "use" In remote-repositories.html changed "-D expression" to "property / parameter" In site.html included more info regarding the APT Format, and provided a link towards the APT Format Guide. Unapplied Comment: In usage.html changing of "specific directory structure" to "maven recommended directory structure" ...this was not applied because the directory structure i am referring to is the directory structure created by maven-archetype-plugin. And it does not necessarily mean that the directory structure produced by the plugin would follow maven's recommended directory structure.
        Hide
        Maria Odea Ching added a comment -

        Second patch applied
        The staging site has also been updated http://people.apache.org/~oching/maven-archetype-plugin

        Show
        Maria Odea Ching added a comment - Second patch applied The staging site has also been updated http://people.apache.org/~oching/maven-archetype-plugin
        Hide
        Dennis Lundberg added a comment -

        I was reading from the staged site and found a couple of typos. So I thought that I'd create a patch, but the staged site does not match what is in SVN. Look at the difference between

        http://people.apache.org/~oching/maven-archetype-plugin/usage.html

        and

        http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype/maven-archetype-plugin/src/site/apt/usage.apt?revision=425587&view=markup

        Show
        Dennis Lundberg added a comment - I was reading from the staged site and found a couple of typos. So I thought that I'd create a patch, but the staged site does not match what is in SVN. Look at the difference between http://people.apache.org/~oching/maven-archetype-plugin/usage.html and http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype/maven-archetype-plugin/src/site/apt/usage.apt?revision=425587&view=markup
        Hide
        Maria Odea Ching added a comment -

        Sorry, it was my fault. I think I forgot to commit the patch I applied locally in my machine.
        Anyway, I already updated both svn and the staging site. Thanks

        Show
        Maria Odea Ching added a comment - Sorry, it was my fault. I think I forgot to commit the patch I applied locally in my machine. Anyway, I already updated both svn and the staging site. Thanks
        Hide
        Franz Allan Valencia See added a comment -

        Changes with ARCHETYPE-45-maven-archetype-plugin-3.patch
        In site.xml
        Switched the arrangement of the "Goals" menu item and the "Usage" menu item (to follow the plugin documentation guidelines, [1])

        In *.apt
        Added the Licensing Agreement based on [1]

        In faq.fml
        Added the Licensing Agreement based on [1]

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

        Show
        Franz Allan Valencia See added a comment - Changes with ARCHETYPE-45 -maven-archetype-plugin-3.patch In site.xml Switched the arrangement of the "Goals" menu item and the "Usage" menu item (to follow the plugin documentation guidelines, [1] ) In *.apt Added the Licensing Agreement based on [1] In faq.fml Added the Licensing Agreement based on [1] [1] http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation
        Hide
        Maria Odea Ching added a comment -

        Patch applied. Thanks

        Show
        Maria Odea Ching added a comment - Patch applied. Thanks

          People

          • Assignee:
            Maria Odea Ching
            Reporter:
            Maria Odea Ching
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 23 hours
              23h
              Remaining:
              Time Spent - 2 hours Remaining Estimate - 21 hours
              21h
              Logged:
              Time Spent - 2 hours Remaining Estimate - 21 hours
              2h