Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document parameter alias names #1676

Open
scottkurz opened this issue May 24, 2023 · 0 comments
Open

Document parameter alias names #1676

scottkurz opened this issue May 24, 2023 · 0 comments

Comments

@scottkurz
Copy link
Member

scottkurz commented May 24, 2023

This isn't a huge deal but a more minor gap you might say in our overall doc story....

PROBLEM

In places like: https://github.com/OpenLiberty/ci.maven/blob/main/docs/common-parameters.md the doc assumes everyone's using the parameter aliases.

E.g. for this parameter:

    @Parameter(alias = "runtimeInstallDirectory", property = "runtimeInstallDirectory", defaultValue = "${project.build.directory}/liberty")
    protected File assemblyInstallDirectory;

we only document the "runtimeInstallDirectory" parameter...but this is just the alias.

OTOH, if you do:

  • mvn liberty:help -Ddetail=true -Dgoal=start
  • Do <Ctrl>+<Space> completion suggestion in Eclipse IDE in the pom.xml

you'll see the suggestion for the 'assemblyInstallDirectory' parameter instead. Trying to cross-reference this in the Markdown doc wouldn't be obvious.

ANOTHER IDEA

Just curious: have we ever looked at the plugin doc that the main Apache plugins use to generate plugin doc to see what it'd look like? Not saying we'd want to do a full "switch", just curious if some of this would be covered already if we were to make that available somehow?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant