[
https://issues.apache.org/jira/browse/MPLUGIN-541?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17926540#comment-17926540
]
Konrad Windszus edited comment on MPLUGIN-541 at 2/12/25 6:41 PM:
------------------------------------------------------------------
The problem with splitting up the report into more pages is that I consider
this backwards incompatible (i.e. links with anchors to plugin-info.html
break). So IMHO such a change (although probably reasonable requires a major
version change).
Regarding
bq. "Plugin Details" is as good or bad as those too in my opinion, because it
has the same unspecific range.
For me you wouldn't refer to the whole website documenting a plugin (like
https://maven.apache.org/plugins/maven-compiler-plugin/) as "Plugin
Documentation", but probably not as "Plugin Details", so for me "Details" is
more suitable for a single page of a website than "Plugin documentation". Does
that make sense?
was (Author: kwin):
The problem with splitting up the report into more pages is that I consider
this backwards incompatible (i.e. links with anchors to plugin-info.html
breaks). So IMHO such a change (although probably reasonable requires a major
version change).
Regarding
bq. "Plugin Details" is as good or bad as those too in my opinion, because it
has the same unspecific range.
For me you wouldn't refer to the whole website documenting a plugin (like
https://maven.apache.org/plugins/maven-compiler-plugin/) as "Plugin
Documentation", but probably not as "Plugin Details", so for me "Details" is
more suitable for a single page of a website than "Plugin documentation". Does
that make sense?
> 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)
