subject:"\[jira\] \[Commented\] \(LUCENE\-9321\) Port documentation task to gradle"



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

Uwe Schindler commented on LUCENE-9321:
---

bq. I am currently cleaning up more, I removed hardcoded task names used to 
refer to "element-list". I think I can also cleanup the bugfix for the split 
package problem without using ant. The code is "unreadable" (it's "Ant style" 
how it is at the moment). It's a 5-liner in Groovy to filter the element-list.

Fixed. It's now a 5-liner, easy to read: 
https://github.com/apache/lucene-solr/pull/1488/commits/764f378bef47f1c375b100cf8755b712c5faca4b

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2h 50m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

bq. I did try this, but breaks on windows and it is hard to handle with paths 
with non-existing files (Path append slashes on directories, but only if they 
exist). So working with virtual paths is hard. 

Actually the code was twice as long as the current code, so simply doing some 
set magic was much easier and behaves consistent, as it's not relying on 
platform dependent things.

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2h 40m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

bq.  I'd just use Path methods (even in convertPath2Link). But I may be talking 
nonsense here.

I did try this, but breaks on windows and it is hard to handle with paths with 
non-existing files (Path append slashes on directories, but only if they 
exist). So working with virtual paths is hard. Other options were 
plexus-utils, but the code here is more or less the way how it works there 
(just much shorter because of Groovy). I think the code now is fine (drop as 
many elements which are common prefix for both paths, then add as many ".." in 
front to get out of the base path). I see this as done for now. Ideas still 
welcome.

I am currently cleaning up more, I removed hardcoded task names used to refer 
to "element-list". I think I can also cleanup the bugfix for the split package 
problem without using ant. The code is "unreadable" (it's "Ant style" how it is 
at the moment). It's a 5-liner in Groovy to filter the element-list.

I will then duplicate the "renderJavadocs" task and set the outputDirectory 
correctly. Currently its doing relative paths for testing purposes everywhere 
(debug output looks fine to me).

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2h 40m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-06 Thread Dawid Weiss (Jira)



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

Dawid Weiss commented on LUCENE-9321:
-

I looked but I think I'll wait with comments until it's closer to workable 
state. I don't know if we absolutely have to go through URI - I'd just use Path 
methods (even in convertPath2Link). But I may be talking nonsense here.

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2h 40m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

I started a PR with this idea: https://github.com/apache/lucene-solr/pull/1488

It's WIP, so have a look. Basically it refactors [~tomoko]'s code to a class 
with properties, so it can be reused for different tasks with completely 
independent setting. The whole thing does not yet work, I just wanted to post 
some eraly results.

The hardest part was to find a good way to create relative links. I started 
with URI#relativize, but this one is buggy, as it needs a common prefix and 
creates no "..".

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2h 40m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-05 Thread Tomoko Uchida (Jira)



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

Tomoko Uchida commented on LUCENE-9321:
---

Thank you, for elaborating.

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-05 Thread Uwe Schindler (Jira)



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

Uwe Schindler commented on LUCENE-9321:
---

bq. There's one thing I'm not fully understand. According to this policy, how 
do we handle links in Solr javadocs to Lucene javadocs. To be strictly 
consistent, those should be relative links for website, but absolute links for 
tar.gz (because Lucene and Solr archives are separately distributed). ?

Sorry for not having a full answer to this on the weekend. The proposal to 
split Lucene and Solr on the development mailinglist was something I did not 
want to make publish.

With that background, I can now confirm my previous statements:
- If solr splits off lucene, the links between both projects need to be 
absolute anyways. Or - removed alltogether from Javadocs, as it's to fragile
- The recent changes also confirm my previous problem with absolute links: Once 
projects split, the current Javadoc repository needs to be moved possibly to 
another *.apache.org subdomain. Of course we will have redirects, but 
nevertheless I don't want to introduce a redirect for every link anywhere in 
the Javadocs. So relative links that link between modules of Solr and/or Lucene 
should be relative, otherwise it's a nightmare to maintain afterwards.

These two reasons are my main arguments for having only relative links between 
modules in the "overall documentation". For individual Maven artifacts I don't 
care, but there the links should be absolute (with configurable location) or 
removed altogether. Somebody using the "javadoc" maven artifact just needs docs 
for the current method heshe is looking at, so we could possibly also remove 
all links there.

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-04 Thread Dawid Weiss (Jira)



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

Dawid Weiss commented on LUCENE-9321:
-

Thanks. Could be me just not expressing myself clearly. I know it's possible to 
work on a pull request together somehow so I can chip in and Tomoko by now is 
javadoc-expert level probably. ;) Let us know if you need help.

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-04 Thread Uwe Schindler (Jira)



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

Uwe Schindler commented on LUCENE-9321:
---

Hi Dawid,

That's my plan. I will work on that. I will also make the absolute "base URL" 
configurable, like in Ant. This allows to generate Maven Snapshot Artifacts on 
Jenkins that have working links.

Last Saturday, I was not sure what you wanted to say, but after reading your 
answer multiple times, I got your point. Sorry. Smartphone is a too small 
device and the Jira Mobile Interface is a usability desaster.

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-04 Thread Dawid Weiss (Jira)



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

Dawid Weiss commented on LUCENE-9321:
-

I read your comment in details (the previous time as well, Uwe). I would like 
to avoid having to render javadocs twice... but if we can't dodge this then 
sure - your approach sounds ok. 

Tomoko did a great job in renderJavadocs. If we are to render them twice then 
the code from renderJavadocs could be turned into a task and just declared 
twice, with different options (target folder, link rendering). Sounds good?

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Tomoko Uchida commented on LUCENE-9321:
---

(It's merely my personal preference, but I really do not like deleting comments 
from an issue tracker even if they are trivial ones, please ...)

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

IMHO: I agree with Dawid, Solr Javadocs should not have links over to Lucene.

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

The Solr bundle does not have the Lucene javadocs, so they need to be absolute, 
but only for that case. This is - I agree with Dawid - something that onbly 
affects the final documentation "ant/gradle documentation" build, which is done 
by release manager and jenkins only. In that case it would produce 2 different 
sets of javadocs (as explained before).

> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Tomoko Uchida commented on LUCENE-9321:
---

bq. I would like to prevent that by just having relative links. This is also 
important for the targz bundle. 

There's one thing I'm not fully understand. According to this policy, how do we 
handle links in Solr javadocs to Lucene javadocs. To be strictly consistent, 
those should be relative links for website, but absolute links for tar.gz 
(because Lucene and Solr archives are separately distributed). ?


> 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: Uwe Schindler
>Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

[~tomoko]: You have unassigned, I will take this issue. 

> 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
>Priority: Major
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

By the way I explained that very detailed in my proposal. Please read!

> 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
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

bq. I wouldn't require a second (independent) build pass. If it's something 
required for the "release" then let's have a release task in gradle and take 
care of it there (javadocs built twice but within the same run of the build - 
the "release" build). Otherwise the "release" scripts are duplicating what 
could as well be done within the main build script?

During the release you build maven artifacts (with absolute links) going to 
local module folder. In addition you build global javadocs with relative links.

Both can be done with a same set of tasks, just dynamically duplicate then in 
the bud module. When doing this change 2 things: the output die and apply 
URI.relativize(). The global documentation task depends on those variants, the 
jar file builds for maven depend on standard javadocs task, that delegates to 
renderJavaDoc with absolute links.

> 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
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

I was talking about historic javadocs with absolute links that need to be 
fixed. I would like to prevent that by just having relative links. This is also 
important for the targz bundle. It should be self contained and not have 
absolute links.

> 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
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Tomoko Uchida commented on LUCENE-9321:
---

{quote}I don't like it to publish HTML pages on lucene.apache.org with absolute 
links to lucene.apache.org. We recently changed to HTTPS, so for similar cases 
all links in historic Javadocs would need to be rewritten. Thanks to redirects 
it still works, but there can be man-in-the-middle problems.
{quote}
I could miss some point, but as for redirecting "renderJavadoc" task emits 
"https:" link so there should be no http access, and hence no http => https 
redirecting; though I have no idea there are other reasons to prefer relative 
paths over absolute urls from security perspective (attackers can take 
advantage valunabilities of ssl/tsl when we use absolute urls instead of 
relative paths?).
 
[https://github.com/apache/lucene-solr/blob/master/gradle/render-javadoc.gradle#L64]
 (I have confirmed it generates "https://~~; links.)

> 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
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Tomoko Uchida commented on LUCENE-9321:
---

bq. Maybe we can dump all links by inserting 'print' and run the script.

I tried to dump all cross-module (relative) links by this patch to 
chackJavadocLinks.py
{code}
diff --git a/dev-tools/scripts/checkJavadocLinks.py 
b/dev-tools/scripts/checkJavadocLinks.py
index 5d07e27a588..a96879536c9 100644
--- a/dev-tools/scripts/checkJavadocLinks.py
+++ b/dev-tools/scripts/checkJavadocLinks.py
@@ -74,6 +74,12 @@ class FindHyperlinks(HTMLParser):
   elif href is not None:
 assert name is None
 href = href.strip()
+absolute_url = urlparse.urljoin(self.baseURL, href)
+prefix1 = '/'.join(urlparse.urlparse(self.baseURL).path.split('/')[:5])
+prefix2 = '/'.join(urlparse.urlparse(absolute_url).path.split('/')[:5])
+# print only cross-module relative links
+if re.match('^../', href) and prefix1 != prefix2:
+  print('%s\t%s\t%s' % (self.baseURL, href, absolute_url))
 self.links.append(urlparse.urljoin(self.baseURL, href))
   elif id is None:
 raise RuntimeError('couldn\'t find an href nor name in link in %s: 
only got these attrs: %s' % (self.baseURL, attrs))
@@ -130,8 +136,9 @@ def checkAll(dirName):
   global failures
 
   # Find/parse all HTML files first
-  print()
-  print('Crawl/parse...')
+  #print()
+  #print('Crawl/parse...')
+  print('filename\trelative path\tabsolute url')
   allFiles = {}
 
   if os.path.isfile(dirName):
@@ -160,8 +167,8 @@ def checkAll(dirName):
 allFiles[fullPath] = parse(fullPath, open('%s/%s' % (root, f), 
encoding='UTF-8').read())
 
   # ... then verify:
-  print()
-  print('Verify...')
+  #print()
+  #print('Verify...')
   for fullPath, (links, anchors) in allFiles.items():
 #print fullPath
 printed = False
{code}

I don't want to attach the results (as the output file is large), but this can 
be run as below
{code}
lucene-solr $ python -B dev-tools/scripts/checkJavadocLinks.py 
lucene/build/docs/ > ~/work/lucene-javadocs-relative-paths.tsv
lucene-solr $ wc -l ~/work/lucene-javadocs-relative-paths.tsv 
31434 /home/moco/work/lucene-javadocs-relative-paths.tsv

lucene-solr $ python -B dev-tools/scripts/checkJavadocLinks.py solr/build/docs/ 
> ~/work/solr-javadocs-relative-paths.tsv
lucene-solr $ wc -l ~/work/solr-javadocs-relative-paths.tsv 
9307 /home/moco/work/solr-javadocs-relative-paths.tsv
{code}

This includes both kind of relative paths - automatically generated links by 
javadoc tool and hand written links by human (I don't know there is a way to 
distinguish them). With gradle scripts on the current master, the number should 
be reduced since all automatically generated links are absolute ones with 
"renderJavadoc" task. 



> 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
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-02 Thread Tomoko Uchida (Jira)



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

Tomoko Uchida commented on LUCENE-9321:
---

bq. How many of these cross-module links are we talking about? Maybe we can 
just dump them altogether?

I think the "checkJavadocLinks.py" does the work. It collects all {{href}} 
attributes in given HTML (regardless of they are absolete or relative, or they 
are external links or cross-module links). Maybe we can dump all links by 
inserting 'print' and run the script.
[https://github.com/apache/lucene-solr/blob/master/dev-tools/scripts/checkJavadocLinks.py#L31]

> 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
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-02 Thread Dawid Weiss (Jira)



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

Dawid Weiss commented on LUCENE-9321:
-

bq. For the website and .tar.gz release (so packaging) the release manager 
should run the whole javadocs a second time (we should not copy them).

I wouldn't require a second pass. If it's something required for the "release" 
then let's have a releast task in gradle and take care of it there. Otherwise 
the "release" scripts are duplicating what could as well be done within the 
main build script?

Also, I'm sorry if this is a stupid question but can we just *not* have any 
cross-module links at all? How many of these cross-module links are we talking 
about? Maybe we can just dump them altogether?


> 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
> Attachments: screenshot-1.png
>
>  Time Spent: 2.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-02 Thread Uwe Schindler (Jira)

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

Uwe Schindler commented on LUCENE-9321:
---

Hi,

as said on the PR, there is actually two (or better three) different ways how
to consume the javadocs and each of those have different requirements with
inter-module links:
# One consumer is using the javadocs from the Maven JAR files (e.g., in the
IDE)
# The other consumers are using the website where the javadocs are all at one
place. They not only do this for releases, but also for snapshot builds by
Jenkins (see below, this makes the current "absolute" links not working they
way how it is setup).
# Somebody downloads the tar.gz file of Lucene and wants to browse the
javadocs from there. Actually I do this all the time when I am validating a
release (because that's the only way to do this, as the javadocs are not yet
deployed on central web page).

The consumer #1 is perfectly fine with current setup. For us it's easy to
package. The only things that is currenty borken is the way how the absolute
links are generated: They are hardcoded!!! This cannot be like that. We have
nightly snapshot builds on Jenkins where we producce snapshots where all
Javadocs go into nowhere. In the ANT build this is handled by making the
"Documentation base URL" configurable for Lucene/Solr: Instead of hardcoding
{{[https://lucene.apache.org/lucene/a_b_c]}} the Jenkins server sets a property
on the ANT invocation. By that all links which are absolute are correct. A
release manager can also set this, but there's currently automatism in ANT: If
the version does not end in "-SNAPSHOT", the links are generated using the
absolute links using the version number. We have version.properties for that.
This is how Jenkins (Solr 8.x Job) is setup, the same should be possible for
Gradle (just define "base URL path" with 2 properties):

!screenshot-1.png|width=753,height=316!

This allows to browse the full documentation here:
[https://builds.apache.org/view/L/view/Lucene/job/Solr-Artifacts-8.x/javadoc/]
(including valid absolute links also cross-project to Lucene). All Snapshot
artifacts deployed on snapshots.apache.org (including ZIP files) have those
links inside. This makes it easy for the user to browse and also somebody using
the artifacts in his IDE (think about Elasticsearch or any other projects using
snapshot artifacts from ASF). They are perfectly fine, it's now also better
than before!

No comes user #3: He downloads the targz/zip file and wants to browser Javadocs
or the development member who votes for a release. He wants to show the
javadocs. Unfortunately he can't as all links are dead (the Javadocs are not
yet published). Also somebody who downloaded the tar.gz file wants to dive
through the documentation with *relative* links. With just copying or
symlinking all Javadocs to some central folder, this isn't satisfied.

User #2 is somehow inbetween, but I tend to make him identical to user #3. I
don't like it to publish HTML pages on lucene.apache.org with absolute links to
lucene.apache.org. We recently changed to HTTPS, so for similar cases all links
in historic Javadocs would need to be rewritten. Thanks to redirects it still
works, but there can be man-in-the-middle problems. I wanted to download the
whole SVN repository in the near future and let run a {{sed}} through it to fix
all old links. This is major work. If links are all relative, you don't have
that problem.

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

They work, because documentation-lint does not check everything. The linter
does not follow absolute links, so it can't verify. It just passes. It's OK to
check that all links in the module are correct, but it can't check the full
documentation. So before a release "documentation-lint" must also be ran on the
tol level. This is a requirement for the release. But for this to work, the
links must be relative.

*Now comes my proposal:*

- I tend to leave the per-project javadocs as is, they should be used to build
maven artifacts. This makes IDE users happy and I hope also Dawid. The only
thing is to allow to configure the lucene and solr specific "base" url for
absolute links. This allows to make snapshot artifacts on Jenkins correctly.
Maybe also copy the "heuristic" from Ant to generate links based on "-SNAPSHOT"
or not.
- For the website and .tar.gz release (so packaging) the release manager should
run the whole javadocs a second time (we should *not* copy them). For this
second run for packaging purposes, we change the Javadocs output directory to
the top-level one (as proposed by Tomoko). In addition the absolute links
should be relative. This can easily be done using java.net.URI class. Just
build the absolute URI for the

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-02 Thread Dawid Weiss (Jira)



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

Dawid Weiss commented on LUCENE-9321:
-

bq. 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. 

I agree with Tomoko here. An additional bonus of not having cross-project 
relative links is that javadocs displayed by IDEs work properly. The top-level 
index is a different matter because it is for site needs only (and then you can 
link relative javadocs for each package).

> 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 20m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-01 Thread Tomoko Uchida (Jira)



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

Tomoko Uchida commented on LUCENE-9321:
---

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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-01 Thread Dawid Weiss (Jira)



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

Dawid Weiss commented on LUCENE-9321:
-

bq. So why are you arguing to have the javadocs splattered around the build 
tree?

Hmm... Personal preference? Something about consolidated top-level "docs" 
folder just stinks to me. We can validate and lint docs where they are within 
the project. I don't think final packaging has anything to do with it - you 
just assemble the javadocs you wish to assemble and put an index file on top, 
done.

If you really, really badly want that single documentation folder then be my 
guest but I don't think it's elegant.

> 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: 0.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

Sorry I still disagree with this:
- On Windows it takes minutes to copy the stuff to one place. In addition the 
whole Javadocs is hundreds of megabytes and I don't want them 2 times on my 
computer, just for packagaing AND linting purposes!
- The precommit / javadoc-lint task (as discussed with [~rcmuir] before in the 
other issue) is there to validate the links and the javadocs as a whole. Just 
to run this task I see no reason to copy all of this around.

In short: There's no problem in changing the JavaPlugin's javadocs output 
folder to place eventhing at a different target location. Even the "gradle 
clean" folder does everything correct. So what's the issue to change th output? 
The Maven packaging should also have no problem with that.

So why are you arguing to have the javadocs splattered around the build tree?

> 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: 0.5h
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-01 Thread Dawid Weiss (Jira)



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

Dawid Weiss commented on LUCENE-9321:
-

I this should be done this way: the task that collects final distribution would 
collect (sync or symlink; Windows may be a problem here) all documentation 
folders from all subprojects (this is easy: iterate over all java projects, get 
the outputDir of javadoc task) and create an index file that would point to all 
of them relative from this top-level. 

I do think javadoc outputs should be kept *with each project*. This is a 
convention and I don't think we should change it. The "flat" structure of 
javadocs is a distribution/ packaging matter and it should be handled there -- 
in the packaging/ distribution project/ task.

I can help you with the details if you wish, Uwe.

> 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: 20m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

I cant proceed with the index.html/index.md template before I know where the 
javadocs finally land and how the directory stricture looks like. I have to 
iterate over all Java projects and collect the relative paths and the titles to 
generate the links in the main index file, so I am a bit stuck now. I am happy 
to implement this, but without javadocs in a central place I can't proceed.

> 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: 20m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle



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

Uwe Schindler commented on LUCENE-9321:
---

Hi, yes please. Could you still have a look at the PR? At least the parts 
(copying assets and also converting markdown works). I added a template task to 
create the index file (it's handled by markdown.gradle because the intention is 
to use the static method in MarkdownFilter#convert(String) to generate the HTML 
from an in memory build Markdownfile as Input for the index file.

> 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: 20m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle

2020-05-01 Thread Tomoko Uchida (Jira)



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

Tomoko Uchida commented on LUCENE-9321:
---

I left a comment about javadocs destination folder on LUCENE-9278 before seeing 
the comments here.
Would we need more discussions about where the outputs of "renderJavadoc" task 
should go, if we still don't get a consensus about it ?

> 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: 10m
>  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

[jira] [Commented] (LUCENE-9321) Port documentation task to gradle