Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-13792

Update to Antora 3.0

    XMLWordPrintable

Details

    • Story
    • Status: In Review (View Workflow)
    • Medium
    • Resolution: Unresolved
    • Meridian-2021.1.6, 29.0.1
    • None
    • Documentation
    • Security Level: Default (Default Security Scheme)
    • None
    • Doc Sprint - Nov 5 - Dec 3, Doc Sprint - Dec 4 - January 7, Doc Sprint - Jan 7 - Feb 4, Docs - Feb 7 - March 4, Docs - March 7 - April 8
    • High High
    • DB

    Description

      Docs build failures regularly occur due to a number of versions of docs included. The ability to tag "latest" or "current" version will allow us to make changes to the build process. Right now we publish always the last stable release with the major version number, e.g. 29 for Horizon and 2021 for Meridian. With Antora 3.0 the feature with floating tags is now available. It will give us the possibility to generate the docs with the URL "latest" instead of the version number. It gives us more stable links and makes it easier for indexers to show search results in search engines.

      Creating

      Attachments

        Issue Links

          blocks

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. NMS-13794 Use master branch version instead of tags to build docs

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          has to be done before

          Bug - A problem which impairs or prevents the functions of the product. NMS-13864 Package description for Minion and Sentinel reference Wiki

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          is triggering

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. NMS-13540 Add search term highlight functionality in documentation

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          Linked issue cannot start until this issue finishes.

          Enhancement - An improvement or enhancement to an existing feature or task. NMS-13912 Replace wiki links across all codebase

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          related to

          Task - A task that needs to be done. NMS-14253 Implement "latest" tag with documentation

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Activity

            People

              indigo Ronny Trommer
              Bonnie Bonnie Robinson
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: