[DOCU-2645] Javadoc extension URLs > static Created: 24/Jan/23  Updated: 06/Mar/23

Status: In Progress
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Alex Mansell Assignee: Alex Mansell
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: File class-path-relation2.csv     File full-javadoc-list.adoc    

 Description   

Replacing dynamic javadoc URLs (using the extension) with static URLs for improve build time.

A script can run the javadoc extension nightly and compiled the static URLs if needed.

Potential workflow

  • Nightly script runs antora extension to get latest nexus URLs for javadoc
  • The output would need to be linked to the playbook variables (which would in turn reflect any updates)
  • Any new nexus URLs detected would be added to the list and a set pattern variable would be created in a PR in the antora site repository.


 Comments   
Comment by Martin Drápela [ 27/Jan/23 ]

we have cases like these:
class is info.magnolia.dirwatch.DirectoryWatcherService
 
it lives in theses artifact coords

groupId: info.magnolia.core
artifactId: magnolia-resource-loader

but for a URL we would need to get this by some regexing search/replace logic

info.magnolia.resourceloader.magnolia-resource-loader 

not doable from just the class name itself

  • we would need to store somewhere the binding of that class with resourceloader.magnolia-resource-loader

 
and further on, the filename is magnolia-resource-loader-5.4-m13-javadoc.jar where the magnolia-resource-loader occurs too
 
Idea:
 
Instead of querying nexus search API, we could aim at Bitbucket API,

 
it might return a full URL path, which has that "unknown" element
 
git.magnolia-cms.com/projects/PLATFORM/repos/main.pub/browse/magnolia-resource-loader/src/main/java/info/magnolia/dirwatch/DirectoryWatcherService.java
 
and use this info to reconstruct the full URL for Nexus
probably worthwhile testing then against bitbucket API

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