Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.1
    • Fix Version/s: 2.0-beta-5
    • Component/s: None
    • Labels:
      None

      Description

      Add examples and FAQs, pass docck, fix navigation and home page to conform with plugin documentation standards.

        Activity

        Hide
        Ernesto S. Tolentino Jr. added a comment -

        Done

        Show
        Ernesto S. Tolentino Jr. added a comment - Done
        Hide
        Natalie Burdick added a comment -

        below are my suggested edits, and a question on terminology

        http://people.apache.org/~jtolentino/maven-release-plugin/index.html

        Maven Release Plugin

        This plugin is used to release a project with Maven, saving a lot of repetitive, manual work. Releasing a project takes two steps: prepare and perform. [are these steps/goals or tasks?would be good to use consistent terms -- also in goals there are three listed and below under examples there are even more -- ]

        Usage

        Instructions on how to use the Maven Release Plugin can be found here.

        Examples

        To provide you with better understanding on some working scenarios for the Maven Release Plugin, you can take a look into the following examples:

        • Perform Release
        • Prepare Release
        • Generate Release POMs
        • Lock Files During Release
        • Run Additional Goals Before Commit

        ---------------------------
        http://people.apache.org/~jtolentino/maven-release-plugin/faq.html - suggested text/language edits:

        1. When releasing from a parent pom, will all the sub-project modules use the same release version and dev version as the parent?

        When releasing from a parent pom, will all the sub-project modules use the same release version and dev version as the parent?

        No, the Maven Release Plugin will prompt for each sub-project's version information.

        [Key is whenever asking a question, don't use negative - 'won't', and always put the actual answer - 'No' in this case, in the response]

        Show
        Natalie Burdick added a comment - below are my suggested edits, and a question on terminology http://people.apache.org/~jtolentino/maven-release-plugin/index.html Maven Release Plugin This plugin is used to release a project with Maven, saving a lot of repetitive, manual work. Releasing a project takes two steps: prepare and perform. [are these steps/goals or tasks?would be good to use consistent terms -- also in goals there are three listed and below under examples there are even more -- ] Usage Instructions on how to use the Maven Release Plugin can be found here. Examples To provide you with better understanding on some working scenarios for the Maven Release Plugin, you can take a look into the following examples: Perform Release Prepare Release Generate Release POMs Lock Files During Release Run Additional Goals Before Commit --------------------------- http://people.apache.org/~jtolentino/maven-release-plugin/faq.html - suggested text/language edits: 1. When releasing from a parent pom, will all the sub-project modules use the same release version and dev version as the parent? When releasing from a parent pom, will all the sub-project modules use the same release version and dev version as the parent? No, the Maven Release Plugin will prompt for each sub-project's version information. [Key is whenever asking a question, don't use negative - 'won't', and always put the actual answer - 'No' in this case, in the response]

          People

          • Assignee:
            Ernesto S. Tolentino Jr.
            Reporter:
            Ernesto S. Tolentino Jr.
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Due:
              Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 31h Original Estimate - 31h
              31h
              Remaining:
              Remaining Estimate - 0h
              0h
              Logged:
              Time Spent - 32h
              32h

                Development