[DOCU-1054] Move javadoc macro to 'confluence-artifact-info-plugin' Created: 11/Jul/17  Updated: 24/Jul/17  Resolved: 21/Jul/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Sprint: Docu Sprint 29
Story Points: 8

 Description   

The task is already - at least slightly described at SYS-1397.
The SYS ticket will remai, that's fine.
I have created this one just to make sure to make it possible to have this task visible on the doc-team board.



 Comments   
Comment by Christoph Meier [ 24/Jul/17 ]

The macro is now part of the confluence-artifact-info-plugin. The plugin has been released - v.1.2 - and installed on both test and productive wiki instances.


User must provide at least the parameter className and may specify the optional parameters version, rangeHigherVersion, rangeLowerVersion; range params. are ignored when a specific version was specified. SNPASHOT is not supported. (We never create javadoc artifacts for SNAPSHOT versions.)
info.magnolia.sys.confluence.plugin.artifactinfo.macro.JavadocLinkMacro


Note that it was necessary to increase the value of the property read-timeout for the jersey client which queries nexus. (From 2'' to 30'' to be on the safe side.) This value can be set in the config. UI of the plugin.
Docu was updated accordingly - see Configuring artifact-info-plugin.
This high read-timeout-value is due to the fact, that the Nexus REST API only takes the parameter cn (className into account, the parameter version will be ignored won such search, which leads to rather big payload on the response.


The macro has a asynchronous and a synchronous mode, the former is the default and gets the real link via AJAX call to a servlet.
Links of javadoc-URLs are cached.

Generated at Mon Feb 12 01:14:45 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.