Skip to content

Improve usage documentation #78

@rsenden

Description

@rsenden

Enhancement Request

Current documentation focuses on configuration options; there's some generic usage documentation, but users need to run the utility to see all supported command-line options for a given configuration for example. It would be good to have the documentation list all supported command-line options (either by configuration file, or by source/target system).

In the simplest form, we could have a 'Command-line Options' section containing sub-sections for each provided configuration file like FoDToJira.xml or SSCToOctane.xml, with each of those sub-sections showing the output of the -help option for that particular configuration file. Primary question is how we can integrate this into the Maven-based build process; potentially we may need to convert to a Gradle-based build for more flexibility.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions