mocobeta edited a comment on issue #1304: LUCENE-9242: generate javadocs by 
calling Ant javadoc task
URL: https://github.com/apache/lucene-solr/pull/1304#issuecomment-593906297
 
 
   @dweiss thanks for your comments, I will try to update the PR.
   
   > I have mixed feelings about the centralized output folder for these 
javadocs... It makes projects very inter-connected and relying on each other. I 
don't know if the linking could be done any different so I think this can be 
left as is and maybe somebody will figure it out later.
   
   I think there is a natural option (and may be only one option as far as I 
know) to not to use centralized output folder and preserve the per-project 
outputs. Solr points to Lucene javadocs via absolute URLs like this. I'm sure 
we can take the same approach for all inter-project links and this will not 
affect on existing (published) folder structure but only on the "href" 
attributes.
   https://github.com/apache/lucene-solr/blob/master/solr/common-build.xml#L298
   
   I have no strong opinions about how the links should be, and it's okay to me 
we change the relative paths to absolute urls when switching to gradle build. 
One concern about switching to use absolute urls is, I think, we will not be 
able to check broken links without fixing `checkJavadocLinks.py` as before 
(this doesn't check if the external links exist or not).
   
   Should we remove all relative paths for inter-module links, to keep projects 
strictly separated? (It looks like just a matter of decision-making...)

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to