Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-12134

validate links to javadocs in ref-guide & hook all ref-guide validation into top level documentation/precommit

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 7.4, 8.0
    • documentation
    • None

    Description

      We've seen a couple problems come up recently where the ref-guide had broken links ot javadocs.

      In some cases these are because people made typos in java classnames / pathnames while editing the docs - but in other cases the problems were that the docs were correct at one point, but then later the class was moved/renamed/removed, or had it's access level downgraded from public to private (after deprecation)

      I've worked up a patch with some ideas to help us catch these types of mistakes - and in general to hook the "bare-bones HTML" validation (which does not require jekyll or any non-ivy managed external dependencies) into ant precommit

      Details to follow in comment/patch...

      Attachments

        1. SOLR-12134.patch
          16 kB
          Chris M. Hostetter
        2. SOLR-12134.patch
          16 kB
          Chris M. Hostetter
        3. nocommit.SOLR-12134.sample-failures.patch
          1 kB
          Chris M. Hostetter

        Activity

          People

            hossman Chris M. Hostetter
            hossman Chris M. Hostetter
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: