[SOLR-14870] gradle build does not validate ref-guide -> javadoc links

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.0
• Assignee: Chris M. Hostetter
• Reporter: Chris M. Hostetter
• Created: 16/Sep/20 00:23
• Updated: 12/May/22 00:26
• Resolved: 12/Oct/20 15:42

Description

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

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

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

Issue Links

• relates to: SOLR-14824 Simplify set of Ref Guide build parameters