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 ]
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: vgaidarji
          Path:
          src/main/resources/index.jelly
          http://jenkins-ci.org/commit/plot-plugin/6401f9169193c12a971e93c6ae858897ca3d1d8b
          Log:
          JENKINS-48537 Move plugin description to wiki

          Previous description was too long and was bloating Plugin Manager list.

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: vgaidarji Path: src/main/resources/index.jelly http://jenkins-ci.org/commit/plot-plugin/6401f9169193c12a971e93c6ae858897ca3d1d8b Log: JENKINS-48537 Move plugin description to wiki Previous description was too long and was bloating Plugin Manager list.
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Veaceslav Gaidarji
          Path:
          src/main/resources/index.jelly
          http://jenkins-ci.org/commit/plot-plugin/490c98c4544f2b09f0d6f45c6ba2a26d3a2b1013
          Log:
          Merge pull request #39 from jenkinsci/JENKINS-48537-fix-plugin-description-length

          JENKINS-48537 Move plugin description to wiki

          Compare: https://github.com/jenkinsci/plot-plugin/compare/20db799e1589...490c98c4544f

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Veaceslav Gaidarji Path: src/main/resources/index.jelly http://jenkins-ci.org/commit/plot-plugin/490c98c4544f2b09f0d6f45c6ba2a26d3a2b1013 Log: Merge pull request #39 from jenkinsci/ JENKINS-48537 -fix-plugin-description-length JENKINS-48537 Move plugin description to wiki Compare: https://github.com/jenkinsci/plot-plugin/compare/20db799e1589...490c98c4544f
          Hide
          vgaidarji Veaceslav Gaidarji added a comment -

          pjdarton Thanks for the report. Fixed, will be included in the next release.

          Show
          vgaidarji Veaceslav Gaidarji added a comment - pjdarton Thanks for the report. Fixed, will be included in the next release.
          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: