Details

    • Task
    • Resolution: Done
    • Major
    • 2.6.0.Final
    • 2.5.0.CR1
    • MTA Documentation
    • None

    Description

      Should be fixed for 2.5.

      The description of the options in docs is IMO not sufficient.
      The "Execute Windup" and the options may be the most visited part of the docs and should be clear.

      In general, the options should
      1) not operate with terms which are kind of Windup specific and assume the user knows what they mean. For example, tag - how does Windup use the concept of tags? Should link to some explanation within the docs.
      2) link some resources where the user may find valid values for some options. For example - excludeTags - where are the tags defined?
      3) Give an example of what the value should look like, or mention it's format. For example, excludePackages - is it a regex? A literal match? A textual * wildcard? Or can the * only replace whole package name subelement?

      https://access.redhat.com/documentation/en/red-hat-jboss-migration-toolkit/version-2.4/windup-user-guide/#command-line-arguments

      We should also review the CLI --help output.

      Attachments

        Issue Links

          Activity

            People

              sgilda_jira Sande Gilda (Inactive)
              ozizka_jira Ondrej Zizka (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: