Plugin Marketplace - how to update Overview and Custom Page?

JetBrains Marketplace
1

How can we update the copy users see in the Jetbrains plugin marketplace, for a plugin that was already published?

My team read through this page but couldn’t find how to edit existing documentation

2

If by “existing documentation” you mean the plugin’s description, you can upload a new version and then hide old ones. As far as I’m aware, there’s no way to “edit” that of an already published version (at least not without actions by JetBrains employees).

3

I guess that’s the part we are unsure of (since we inherited the plugin) - does it pull from the plugins README?

4

That depends on what your build process looks like. If it’s the same as that of the template, then, yes, the description is extracted from the README.

(It may also be the case that the description is defined directly using the <description> tag in your plugin.xml.)

5

Thanks, I see the Overview content might be related to the readme.

Do you know where the source of the “Documentation” tab is?

6

That seems to be a custom page.

7

thanks! to edit or remove this, do we need to reach out to Jetbrains admin?

8

Probably not. You should be able to edit/remove them by accessing /edit/custom-pages.

9

@claire.almh you might need to reach out to them if your account is not associated with the account used to publish the plugin. If you have access to the account that published the plugin, then you should be able to just edit as @insyncwithfoo mentioned directly above.

To summarize:

  1. The description might be taken from either:
    1. the README.md file (like here in another plugin in “Pieces” GitHub org), or
    2. directly from the plugin.xml’s <description> tag, should it exist in the file
    3. Note: After building the plugin locally, you can extract the contents of the zip file and should see whatever description is used in the plugin.xml file (1.2) since the first way (1.1) just copies what is in the README.md into the plugin.xml.
  2. The “Documentation” page is likely a custom page, and you’ll need to use the account that uploads the plugin to edit that tab (or contact the marketplace team directly for assistance; marketplace@jetbrains.com)

Btw, don’t forget to mark the thread with a “solution” (once you have one, of course) to indicate to others accordingly.

3 Likes