[
https://issues.apache.org/jira/browse/MPLUGIN-541?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17926498#comment-17926498
]
Matthias Bünger commented on MPLUGIN-541:
-----------------------------------------
I think this issue is very similar to the one for the renaming from "Goals" to
"Plugin documentation" (#MPLUGIN-492). The it was stated that the page is more
than goals and therefore "goals" is not accurate and maybe "Plugin Info" (which
is the file name of the report) or (as decided) "Plugin Documentation". "Plugin
Details" is as good or bad as those too in my opinion, because it has the same
unspecific range.
And we already have a page "Project information" - which might be very
confusing for people that are not familiar about what a maven plugin and a
maven project is.
Let's take a look at the report (for example of the clean plugin:
https://maven.apache.org/plugins/maven-clean-plugin/plugin-info.html ). We have
* List of goals with a description
* System requirements and its history
* Usage (which is different from the navigation entry
"[Usage|https://maven.apache.org/plugins/maven-clean-plugin/usage.html]"in
terms of where do I have to include the plugin in the POM.
For me this are at least two different kinds of reports:
* A generic one of minimal usage documentation (goals)
* System requirements to be able to use the plugin
The "how to include it in pom" could be added to both of it, doesn't fit both
well, but you could also argue it somehow fits there (esp. from the point of
view that these reports are generated).
So maybe we should think about splitting the report and add more specific ones
which explicit navigation entries in the "project report" sections?
> Rename report from "Plugin Documentation" to "Plugin Details"
> -------------------------------------------------------------
>
> Key: MPLUGIN-541
> URL: https://issues.apache.org/jira/browse/MPLUGIN-541
> Project: Maven Plugin Tools
> Issue Type: Improvement
> Components: Plugin Reporting Plugin
> Reporter: Konrad Windszus
> Assignee: Konrad Windszus
> Priority: Major
>
> The report name/title being used in
> https://github.com/apache/maven-plugin-tools/blob/bc2daa4bb2b71b13e9de7014aad97bd6b6b0f5c4/maven-plugin-report-plugin/src/main/resources/plugin-report.properties#L20C2-L20C40
> is very generic (e.g. used in
> https://maven.apache.org/plugins/maven-compiler-plugin/plugin-info.html).
> Usually the plugin documentation is the whole site (not just the one report
> of it).
> I propose to rename that to "Plugin Details" (or "Plugin Info") so that there
> is a better distinction between an index page of the site of the module and
> this main report page.
> The page name of the report is "plugin-info"
> (https://github.com/apache/maven-plugin-tools/blob/bc2daa4bb2b71b13e9de7014aad97bd6b6b0f5c4/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java#L262C17-L262C23).
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
