[ 
https://issues.apache.org/jira/browse/LUCENE-9321?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17097754#comment-17097754
 ] 

Tomoko Uchida edited comment on LUCENE-9321 at 5/2/20, 12:16 AM:
-----------------------------------------------------------------

As to precommit / javadoc linting, at the moment I don't simply understand why 
it have to depend on "documentation" task. The only problem for that is 
{{check-broken-link}}, "to check if all relative paths are effective"; we 
already have dropped most of the relative paths in our Javadocs on LUCENE-9278 
for clean-up, but there are still some links from "lucene-core" to child 
modules. Instead of gathering all javedocs into one place and checking relative 
links, could we fix the linting script to make it work with per-project folder 
? In the script, I think we also can forbid someone to add relative links 
(which strengthens interdependencies between sub-projects) any more. To me it 
does not look a very big deal.

Other linting tasks in ant's "documentation-lint", {{ecjLint}} and 
{{checkMissingDocs}} work fine with per-project javadoc folder.


was (Author: tomoko uchida):
As to precommit / javadoc linting, at the moment I don't simply understand why 
it have to depend on "documentation" task. The only problem for that is 
{{check-broken-link}}, "to check if all relative paths are effective"; we 
already have dropped most of the relative paths in our Javadocs on LUCENE-9278 
for clean-up, but there are still some links from "lucene-core" to child 
modules. Instead of gathering and checking relative links, could we fix the 
linting script to make it work with per-project folder ? In the script, I think 
we also can forbid someone to add relative links (which strengthens 
interdependencies between sub-projects) any more. To me it does not look a very 
big deal.

Other linting tasks in ant's "documentation-lint", {{ecjLint}} and 
{{checkMissingDocs}} work fine with per-project javadoc folder.

> Port documentation task to gradle
> ---------------------------------
>
>                 Key: LUCENE-9321
>                 URL: https://issues.apache.org/jira/browse/LUCENE-9321
>             Project: Lucene - Core
>          Issue Type: Sub-task
>          Components: general/build
>            Reporter: Tomoko Uchida
>            Assignee: Tomoko Uchida
>            Priority: Major
>          Time Spent: 1h
>  Remaining Estimate: 0h
>
> This is a placeholder issue for porting ant "documentation" task to gradle. 
> The generated documents should be able to be published on lucene.apache.org 
> web site on "as-is" basis.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to