Uploaded image for project: 'Terrier Core'
  1. Terrier Core
  2. TR-462

Standardizing Javadoc Link Structure Across Release Formats

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 4.1
    • Fix Version/s: 4.2
    • Component/s: None
    • Labels:
      None

      Description

      From 4.2 onwards, there are three different versions of the documentation.
       > Website (HTML)
       > Github (Markdown)
       > Release Jar (Markdown)

      For simplicity, all links in all versions will be local. This means that for the Github version, all javadoc links will not work.

      For the moment, the Website version will be considered as the primary documentation source. Users should be directed there where possible.

        Attachments

          Activity

          Hide
          richardm Richard McCreadie added a comment -

          Committed 4.2.1 7db857b1

          Show
          richardm Richard McCreadie added a comment - Committed 4.2.1 7db857b1
          Hide
          richardm Richard McCreadie added a comment -

          Local Links 4.2.1 c3bf88d3

          Show
          richardm Richard McCreadie added a comment - Local Links 4.2.1 c3bf88d3
          Hide
          richardm Richard McCreadie added a comment -

          README.md updated to point to the terrier website: 4.2.1 86236611

          Show
          richardm Richard McCreadie added a comment - README.md updated to point to the terrier website: 4.2.1 86236611

            People

            • Assignee:
              craigm Craig Macdonald
              Reporter:
              richardm Richard McCreadie
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: