Duplicated plugin titles in Update Centre

[Christopher Orr]

Hi all,

I've seen that there are some plugins that are listed multiple times in
the Update Centre.

This happens because the UC generation code uses the wiki page title as
the "title" value in the UC JSON (falling back to the <name> tag in the
pom.xml, and then falling back to the artifact ID).

So, when there are multiple plugins pointing to the same wiki URL (the
most obvious example is workflow), each plugin is listed with the same
name (e.g. "Workflow Plugin") in the UC. Same goes for the plugin
excerpt text.

Ideally every plugin should have its own separate wiki page, but does
anybody have any ideas as to how this could be solved in the meantime?

One quick idea, in the vein of existing "override" solutions: a
wiki-title-overrides.properties file, where entering an artifact ID
forces the UC generation to fall back to the <name> tag for the title?

Any other ideas?

Thanks,
Chris

[Kanstantsin Shautsou]

Why URL based title at all used for plugin name?

[Daniel Beck]

On 16.06.2015, at 01:52, Christopher Orr <ch...@orr.me.uk> wrote:

> This happens because the UC generation code uses the wiki page title as the "title" value in the UC JSON (falling back to the <name> tag in the pom.xml, and then falling back to the artifact ID).

Just use pom name > Wiki page title > artifact ID.

[Christopher Orr]

Yeah, I looked into it and that should work — I'm surprised how
reasonable the <name> tags are in most cases.

I made a quick report of what the current and new names would be (where
they differ from one another), and a list of proposed clean-up rules
(e.g. remove "Jenkins" from every name, and remove "plugin" from the end):
https://gist.github.com/orrc/7a6e2b0605306f6d215e

Regards,
Chris

[Daniel Beck]

On 17.06.2015, at 00:47, Christopher Orr <ch...@orr.me.uk> wrote:

> I made a quick report of what the current and new names would be (where they differ from one another), and a list of proposed clean-up rules (e.g. remove "Jenkins" from every name, and remove "plugin" from the end):
> https://gist.github.com/orrc/7a6e2b0605306f6d215e

'Jenkins' prefix already gets removed in the Jenkins UI. And the others can be done some other time, we already had these same issues with wiki page names.

Also, this will finally resolve the issue that installed plugins have a different name than available plugins, right?

[Christopher Orr]

On 17/06/15 09:23, Daniel Beck wrote:
>
> On 17.06.2015, at 00:47, Christopher Orr <ch...@orr.me.uk> wrote:
>
>> I made a quick report of what the current and new names would be (where they differ from one another), and a list of proposed clean-up rules (e.g. remove "Jenkins" from every name, and remove "plugin" from the end):
>> https://gist.github.com/orrc/7a6e2b0605306f6d215e
>
> 'Jenkins' prefix already gets removed in the Jenkins UI. And the others can be done some other time, we already had these same issues with wiki page names.

Well, fixing these plugins requires updating the <name> tag and making a
release.

After removing the "Jenkins " prefix, there are still at least 69 that
have "Jenkins" or "Hudson" in the name — it seems unlikely that somebody
is likely to fix them (in a consistent way) and release them.

> Also, this will finally resolve the issue that installed plugins have a different name than available plugins, right?

Since there is already basic stripping of the "Jenkins " prefix inside
of Jenkins itself, how about we extend that with the few extra clean-up
rules I proposed?

As you say, fixing the original issue by making Update Centre use <name>
as the plugin name would mean then both the "Available" and "Installed"
tabs will display names consistently.

Adding the extra clean-ups would remove more redundancy, improving names
like "Hudson Testability Explorer Plug-in", "Maven Metadata Plugin for
Jenkins CI server", and "Computer-queue-plugin".

I updated the Gist with the cleaned-up names; to me, it appears to work
well in virtually every case:
https://gist.github.com/orrc/7a6e2b0605306f6d215e

What do you think?

Regards,
Chris

[Kanstantsin Shautsou]

Sent from my iPad

> --
> You received this message because you are subscribed to a topic in the Google Groups "Jenkins Developers" group.
> To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-dev/5BJjqSzo0iU/unsubscribe.
> To unsubscribe from this group and all its topics, send an email to jenkinsci-de...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/5581814F.8030007%40orr.me.uk.
> For more options, visit https://groups.google.com/d/optout.

I think half of this stripped names will violate licenses.
Removing jenkins word from jenkins plugin sounds logical, but removing word hudson is bad, because plugins can be really for hudson.
Also this list looks like i'm installing a tool or service and to a plugin.
I'am against removing word "plugin" and such stripping.

[Mirko Friedenhagen]

Hello Christopher,

while I am a big fan of cleanups and appreciate the work you did here I do not like removing plugin.
When I look at the page name it should be obvious what kind of kind of page I have in front of me. I am in the Jenkins Wiki, so Jenkins is not needed. But more generic words like git or cloudbees could describe anything, from how to use git while developing or what Cloudbees, Docker etc is.

Maybe "abstract" plugins like git-client could be named consistently as base-plugin to indicate that they are not usable by themselves?

Regards
Mirko
--
Sent from my mobile

You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/C27CEC40-67B2-4761-B228-D1063CA17402%40gmail.com.

[Christopher Orr]

Yeah, I don't have too strong an opinion either way on removing "plugin".

I agree that when I'm on the Jenkins wiki, it's clear that everything
relates to Jenkins. But similarly, when I'm inside my Jenkins instance,
and click on "Manage Plugins" and end up in the Plugin Manager, I am
fairly sure that it relates to Jenkins plugins and nothing else — so in
this case it's not really necessary to suffix everything with "plugin" :)

Other software that has extensions or plugins tend to do the same, e.g.:
https://chrome.google.com/webstore/category/extensions
https://addons.mozilla.org/en-US/firefox/extensions/
https://wordpress.org/plugins/browse/popular/


Also, note that these plugin display names do not exist in isolation —
the plugin description text is always displayed underneath each name
(many of which include the text "this plugin..."), e.g. for git it would
say:

Git
This plugin allows use of Git as a build SCM. [...]


But again, my proposals are just proposals :)

Regards,
Chris

On 18/06/15 07:09, Mirko Friedenhagen wrote:
> Hello Christopher,
>
> while I am a big fan of cleanups and appreciate the work you did here I
> do not like removing plugin.
> When I look at the page name it should be obvious what kind of kind of
> page I have in front of me. I am in the Jenkins Wiki, so Jenkins is not
> needed. But more generic words like git or cloudbees could describe
> anything, from how to use git while developing or what Cloudbees, Docker
> etc is.
>
> Maybe "abstract" plugins like git-client could be named consistently as
> base-plugin to indicate that they are not usable by themselves?
>
> Regards
> Mirko
> --
> Sent from my mobile
>
> Am 17.06.2015 17:55 schrieb "Kanstantsin Shautsou"

> <kanstan...@gmail.com <mailto:kanstan...@gmail.com>>:

>
>
>
> Sent from my iPad
>
> > On Jun 17, 2015, at 5:16 PM, Christopher Orr <ch...@orr.me.uk

> <mailto:ch...@orr.me.uk>> wrote:
> >
> >> On 17/06/15 09:23, Daniel Beck wrote:
> >>
> >>> On 17.06.2015, at 00:47, Christopher Orr <ch...@orr.me.uk

[domi]

I fully agree with Chris, we should remove the suffix, as the plugin names are always shown in a context where its clear its nothing else.
/Domi

> --
> You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.

> To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/5582D503.6050602%40orr.me.uk.