How to add documentation link to Jira plugin (not in MarketPlace)

[Jan-Willem Veldhuis]

See image below, how to get a "Documentation" url?

Would like to point it to a wiki page on our intranet. Could not find a way of displaying an URL at the Manage Add-Ons page for my plugin.

[Boris Berenberg · Accepted solution]

You should be able to add this by using:

<param name="documentation.url">{{documentationUrl}}</param>

in your plugin.xml file. See: https://developer.atlassian.com/display/UPM/Plugin+Metadata+Files+used+by+UPM+and+Marketplace for more information (it is currently missing this property and https://ecosystem.atlassian.net/browse/DEVREL-952 has been opened to add it).

Cheers,
Boris

[Jan-Willem Veldhuis]

Hi Boris,

thanks for your reply. I tried it, but it does not work.

The Documentation link doesn't show, even after uninstalling and re-installing the plugin (did a clean build of the plugin after changes).

Confirmed that changes to plugin xml are being picked up, by adding the <param name="configure.url"> (after reinstall it shows a Configure button), so the documenation.url is not being used.

So perhaps you can add this to DEVREL-952 as well? I'm confident it will be resolved in a future release. As this is a minor issue for me, I will leave it without a url for now.

Thanks,

Jan-Willem

[Boris Berenberg]

Was the <param> placed within the <plugin-info> element in the atlassian-plugin.xml? Can you share your atlassian-plugin.xml?

[Jan-Willem Veldhuis]

<atlassian-plugin key="${project.groupId}.${project.artifactId}" name="${project.name}" plugins-version="2">
    <plugin-info>
        <description>${project.description}</description>
        <version>${project.version}</version>
        <vendor name="${project.organization.name}" url="${project.organization.url}" />
        <param name="plugin-icon">images/icon.jpg</param>
        <param name="plugin-logo">images/logo.png</param>
        <param name="documentation.url">${project.organization.url}</param>
        <!-- also tried and not working:
        <param name="documentation.url">http://intranet/wiki/jira-mail-handler</param>
        <param name="documentation.url">{{http://intranet/wiki/jira-mail-handler}}</param>
        -->
    </plugin-info>

    <resource type="i18n" name="i18n" location="mail-handler"/>
   
    <message-handler i18n-name-key="mailhandler.name" key="mailHandler" 
        class="com.company.plugin.MailHandler"
        add-edit-url="/secure/admin/EditHandlerDetailsUsingParams!default.jspa" weight="0"/>
    
</atlassian-plugin>

[Boris Berenberg]

I spoke with some of my team members and it looks like I am wrong. At this time, there is no way to display a documentation link without putting the plugin into the marketplace. Your options are to either put the plugin on Marketplace, or to wait for the feature request I have filed for this to be filled: https://ecosystem.atlassian.net/browse/UPM-3947 From my discussion with them, it doesn't sound like this will be on a short term roadmap.

[Jan-Willem Veldhuis]

Marked as Answer, though there is no solution for this yet.

Boris, thanks for your assistance!