Settings.png screenshot is too large for IntelliJ plugin tool window

[nadia-tarashkevich]

IntelliJ Platform UI team supporter here.

Problem: the plugin description window has horizontal scrollbar in IDE

Investigation: the plugin description is imported from readme.md file, this file contains a screenshot settings.png (https://github.com/redhat-developer/intellij-dependency-analytics/blob/main/src/main/resources/images/settings.png) file which is 1956 × 1430 pixels

Therefore, all page content receives a minimal width of 1956, which leads to a horizontal scrollbar

Proposed solution: replace the image by the resized version 800x585

Additionally, I posted a ticket to our documentation system, so that the plugin developers can know about the recommended best practices for embedding the screenshot.

[soul2zimate]

To thoroughly resolve this issue, we should move the screenshots and images from the plugin description section in plugin.xml to the plugin page in marketplace. It's the recommended way as described in https://plugins.jetbrains.com/docs/marketplace/best-practices-for-listing.html#plugin-description

Use the Media section to add images that illustrate your plugin’s functionality, rather than embedding them directly in the plugin description.

[ptomanRH]

Fred can't change the description on the JB Marketplace. At best he can attach screenshots to the marketplace entry. We need to fix our plugin.xml description in https://github.com/redhat-developer/intellij-dependency-analytics/blob/main/src/main/resources/META-INF/plugin.xml and republish it.

[soul2zimate]

The tag in plugin.xml is rendered as HTML, but using a very restricted subset of what the JetBrains Plugin Repository and IDEs allow.

Again, JetBrains recommends not embedding large images directly in inside plugin.xml. Instead, they advise using the Marketplace “Media” section to upload screenshots. So resize the image is not really helpful as we don't know the user preferred window size and image is not automatically adjusted when user drags and resize IDE window.

I can resize image to 50% of current size in https://github.com/redhat-developer/intellij-dependency-analytics/pull/228, but the outcome is limited. Otherwise, we should just remove the image and gif from tag in plugin.xml.