Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-48537

Cosmetic: Plugin description too long

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Resolved (View Workflow)
    • Priority: Trivial
    • Resolution: Fixed
    • Component/s: plot-plugin
    • Labels:
    • Environment:
      Fresh install of Jenkins 2.89.1 with plot-plugin version 2.0.0
    • Similar Issues:

      Description

      Please shorten the plugin's description field.

      It is customary for plugins to present their human-friendly name and a short description in the "Plugin Manager" page on Jenkins.
      e.g. the "envinject" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "example-short-description.png" for screenshot).

      The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "current-too-long-description.png" for screenshot).

      While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
      I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".

        Attachments

          Activity

          pjdarton pjdarton created issue -
          pjdarton pjdarton made changes -
          Field Original Value New Value
          Description Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "example-short-description.png" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "current-too-long-description.png" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40679/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "current-too-long-description.png" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          pjdarton pjdarton made changes -
          Description Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40679/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "current-too-long-description.png" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40680/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "current-too-long-description.png" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          pjdarton pjdarton made changes -
          Description Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40680/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "current-too-long-description.png" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40680/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "[current-too-long-description.png|https://issues.jenkins-ci.org/browse/JENKINS-48537?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          pjdarton pjdarton made changes -
          Description Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40680/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "[current-too-long-description.png|https://issues.jenkins-ci.org/browse/JENKINS-48537?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "suggested-shortened-description.png", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40680/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "[current-too-long-description.png|https://issues.jenkins-ci.org/browse/JENKINS-48537?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "[suggested-shortened-description.png|https://issues.jenkins-ci.org/secure/attachment/40678/suggested-shortened-description.png]", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          pjdarton pjdarton made changes -
          Description Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40680/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "[current-too-long-description.png|https://issues.jenkins-ci.org/browse/JENKINS-48537?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "[suggested-shortened-description.png|https://issues.jenkins-ci.org/secure/attachment/40678/suggested-shortened-description.png]", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          Please shorten the plugin's description field.

          It is customary for plugins to present their human-friendly name and a short description in the "[Plugin Manager|http://localhost:8080/pluginManager/installed]" page on Jenkins.
          e.g. the "[envinject|https://plugins.jenkins.io/envinject]" plugin has a human-friendly name of "Environment Injector Plugin" and a description of "This plugin makes it possible to set an environment for the builds.", resulting in a concise entry in the Plugin Manager WebUI (see "[example-short-description.png|https://issues.jenkins-ci.org/secure/attachment/40680/example-short-description.png]" for screenshot).

          The plot-plugin, however, has a lengthy description which bloats out the Plugin Manager page (see "[current-too-long-description.png|https://issues.jenkins-ci.org/secure/attachment/40679/current-too-long-description.png]" for screenshot).

          While this documentation is useful, it shouldn't be here - a better place for it would either be on the plugin's wiki page or preferably within online help built into the plugin itself.
          I would suggest that this text be truncated at the end of the first sentence, resulting in something like "[suggested-shortened-description.png|https://issues.jenkins-ci.org/secure/attachment/40678/suggested-shortened-description.png]", and the rest of the text placed in the plugin's wiki page or (preferably) within the online help built into the plugin itself for the Post-build Action "Plot build data".
          vgaidarji Veaceslav Gaidarji made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          vgaidarji Veaceslav Gaidarji made changes -
          Status In Progress [ 3 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]

            People

            • Assignee:
              vgaidarji Veaceslav Gaidarji
              Reporter:
              pjdarton pjdarton
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: