[
https://issues.apache.org/jira/browse/SOLR-14870?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17197264#comment-17197264
]
Chris M. Hostetter commented on SOLR-14870:
-------------------------------------------
{quote}OK, sorry for being inprecise. ...
{quote}
not your fault – just me not understanding the gradle build enough yet to havea
coherent conversation about it – and in particular misunderstanding (and having
backwards) what you're calling "local" javadocs vs "global" javadocs and
how/when/why things should (or should not) link to them.
{quote}The checklinks task in the refguide depends on the "global javadocs" /
"documentation" task ...
{quote}
yup yup ... we're on the same page.
{quote}.. If I have some time tomorrow morning, I may be able to help you.
{quote}
No worries, lemme get SOLR-14824 committed (which will clean up some of the
existing cruftin the ref-guide build.gradle) and then i'll take a stab at:
* refactoring the {{buildSite}} task (and deps) to separate out the "build"
logic from the "check" logic
* refactoring the logic in the build/check tasks into custom ["Task
Types"|https://docs.gradle.org/current/userguide/custom_tasks.html] with
parameterized javadoc urls / validation flags
* adding new "local" versions of build/check using that use the (relative)
path to the "global" javadocs and indicate that all links should be verified
> gradle build does not validate ref-guide -> javadoc links
> ---------------------------------------------------------
>
> Key: SOLR-14870
> URL: https://issues.apache.org/jira/browse/SOLR-14870
> Project: Solr
> Issue Type: Task
> Security Level: Public(Default Security Level. Issues are Public)
> Reporter: Chris M. Hostetter
> Priority: Major
>
> the ant build had (has on 8x) a feature that ensured we didn't have any
> broken links between the ref guide and the javadocs...
> {code}
> <target name="documentation" description="Generate all documentation"
> depends="javadocs,changes-to-html,process-webpages">
> <ant dir="solr-ref-guide" target="bare-bones-html-validation"
> inheritall="false">
> <propertyset refid="uptodate.and.compiled.properties"/>
> <property name="local.javadocs" value="true" />
> </ant>
> </target>
> {code}
> ...by default {{cd solr/solr-ref-guide && ant bare-bones-html-validation}}
> just did interanal validation of the strucure of the guide, but this hook
> ment that {{cd solr && ant documentation}} (or {{ant precommit}}) would first
> build the javadocs; then build the ref-guide; then validate _all_ links i
> nthe ref-guide, even those to (local) javadocs
> While the "local.javadocs" property logic _inside_ the
> solr-ref-guide/build.xml was ported to build.gradle, the logic to leverage
> this functionality from the "solr" project doesn't seem to have been
> preserved -- so currently, {{gradle check}} doesn't know/care if someone adds
> a nonsense javadoc link to the ref-guide (or removes a class/method whose
> javadoc is already currently to from the ref guide)
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
