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

Online documentation links in snapshot builds are invalid

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Resolved (View Workflow)
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: Meridian-2019.1.3, 25.2.0
    • Fix Version/s: None
    • Security Level: Default (Default Security Scheme)
    • Labels:
    • Environment:
      Any installation made from snapshot packages. Seen in customer production environment when snapshots were deployed to get a hotfix in place.
    • HB Backlog Status:
      NB

      Description

      When using a snapshot build, the links to the online documentation in includes/help-documentation.jsp are invalid. It appears the code that generates the links naïvely assumes that the version reported by Vault is a valid slug for which docs have been built and deployed.

      The code that generates these links is in a JSP scriptlet and is of the form:

      href="https://docs.opennms.org/opennms/releases/<%=Vault.getProperty("version.display")%>/guide-install/guide-install.html"

      The resulting links look like:

      https://docs.opennms.org/opennms/releases/25.0.0-0.20200227.opennms518.jira.nms.1/guide-admin/guide-admin.html

       Simply truncating the links at the first hyphen character might suffice. For bonus points, we should display a warning indication that the docs on the other side of the jump might not correspond exactly to the code running in the user's environment.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              jeffg Jeff Gehlbach
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                HB Grooming Date:

                  Git Integration