plugins should not rely on help from jenkins core

XMLWordPrintable

    https://github.com/jenkinsci/jenkins/pull/3921#issuecomment-489697493

    Of course plugins should not assume particular core resource paths exist.

    Three cases:

    1. Plugins are clearly using jenkins resources:

    https://github.com/jenkinsci/copyartifact-plugin/search?q=%22help%2Fparameter%22&unscoped_q=%22help%2Fparameter%22

    26  <f:entry title="${%Name}" field="name" help="/help/parameter/name.html">
    …
    31  <f:entry title="${%Description}" field="description" help="/help/parameter/description.html">

    https://github.com/jenkinsci/credentials-plugin/search?q=%22help%2Fparameter%22&unscoped_q=%22help%2Fparameter%22

    30  <f:entry field="name" title="${%Name}" help="/help/parameter/name.html">
    …
    42  <f:entry field="description" title="${%Description}" help="/help/parameter/description.html"> 

    2. Plugins have odd packaging that should probably be cleaned up:

    jenkinsci/inflectra-spira-integration-plugin – MANIFEST.MF
    Showing the top four matches Last indexed on Jul 2, 2018
    56 Name: images/24x24/new-package.gif
    57 SHA-256-Digest: CW11p3uORd+6Aqj8xT5lnKk4/N0CksvvLKFT5YNA5Xk=
    58
    59 Name: help/parameter/description_de.html
    …
    67 SHA-256-Digest: vcYT1gZV+rXn9416S1c+inLNMRAXbUy4XvDr1+ZY0hE=
    68
    69 Name: help/parameter/string-default.html
    70 SHA-256-Digest: QzAORXruCAhw408m/9i6iMGFG+qbX7dKKT+eHu3uufU= 

    3. plugins should use field= instead of help=:

    jenkinsci/p4-plugin – index.jelly
    Showing the top two matches Last indexed on Jun 27, 2018 XML
    14                    <f:entry title="${parameter.name}" description="${parameter.description}" help="/plugin/p4/help-${parameter.name}.html">
    15                        <div> 

     

          Assignee:
          Bruno P. Kinoshita
          Reporter:
          Josh Soref
          Votes:
          1 Vote for this issue
          Watchers:
          3 Start watching this issue

            Created:
            Updated: