Skip to content

Commit

Permalink
There are no examples
Browse files Browse the repository at this point in the history
and various grammar and style fixes
  • Loading branch information
elharo authored Dec 19, 2024
1 parent 5af2179 commit ce263a1
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -28,40 +28,32 @@

${project.name}

The JLink Plugin is intended to create a {{{https://openjdk.java.net/jeps/220}Modular Java Run-Time Images}}
The JLink Plugin creates {{{https://openjdk.java.net/jeps/220}Modular Java Run-Time Images}}
via {{{https://openjdk.java.net/jeps/282}jlink}}.

* Goals Overview

The JLink Plugin has two goals:

* {{{./jlink-mojo.html}jlink:jlink}} create a Java Run Time Image from <<jar>>/<<jmod>> files.
* {{{./jlink-mojo.html}jlink:jlink}} creates a Java Run Time Image from <<jar>>/<<jmod>> files.

* {{{./help-mojo.html}jlink:help}} displays help information on maven-jlink-plugin.
* {{{./help-mojo.html}jlink:help}} displays help information for the maven-jlink-plugin.

[]

* Usage

General instructions on how to use the JLink Plugin can be found on the {{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below.
General instructions on how to use the JLink Plugin can be found on the {{{./usage.html}usage page}}.

In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
If you have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{./mailing-lists.html}mail archive}}.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
If the plugin is missing a feature or has a defect, you can file a feature request or bug report in our
{{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
concern. Especially for fixing bugs, it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./scm.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.

* Examples

To provide you with better understanding on some usages of the Maven JLink Plugin,
you can take a look into the following {{{./usage.html}examples}}

[]

0 comments on commit ce263a1

Please sign in to comment.