Uploaded image for project: 'FreeNAS / TrueNAS'
  1. FreeNAS / TrueNAS
  2. NAS-101244

Point Guide link to version of online Guide that matches running version

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done (View Workflow)
    • Priority: Low
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 11.2-U5
    • Component/s: Middleware
    • Labels:
      None
    • Attempts to pass:
      1
    • QA Status:
      Test Passes FreeNAS
    • Acceptance Criteria:
      Hide
      1. Online documentation did not have new versions for each release, just for numbered releases. So online docs for 11.2-U4 would have redirected to just 11.2. Now, online help links will link to the exact released version. Note that online docs are not published until the release, so these will give 404 errors, but the important part is that the URL shows /freenas/11.2-U4 rather than just /freenas/11.2. Test this by clicking on the Guide link.

      2. Online help previously had ?running_version= values in the URLs. These have been removed. Any online help URL should no longer have them. Example: Go to Directory Services/LDAP/ADVANCED MODE, then click on the helptext for Kerberos Realm. Then click the link in the helptext to Kerberos Realms. The URL should be "https://ixsystems.com/documentation/freenas/11.2-U4/directoryservices.html#kerberos-realms". Note the 11.2-U4 and no ?running_version.
      (All of the changes are listed in https://github.com/freenas/webui/pull/2231/files).

      Again, these links will give a 404 until after release, but it is the value of the links that is important.

      Docs: FN versions should be double-checked and same verbiage should be used for TN versions of the Guide.
      Show
      1. Online documentation did not have new versions for each release, just for numbered releases. So online docs for 11.2-U4 would have redirected to just 11.2. Now, online help links will link to the exact released version. Note that online docs are not published until the release, so these will give 404 errors, but the important part is that the URL shows /freenas/11.2-U4 rather than just /freenas/11.2. Test this by clicking on the Guide link. 2. Online help previously had ?running_version= values in the URLs. These have been removed. Any online help URL should no longer have them. Example: Go to Directory Services/LDAP/ADVANCED MODE, then click on the helptext for Kerberos Realm. Then click the link in the helptext to Kerberos Realms. The URL should be " https://ixsystems.com/documentation/freenas/11.2-U4/directoryservices.html#kerberos-realms ". Note the 11.2-U4 and no ?running_version. (All of the changes are listed in https://github.com/freenas/webui/pull/2231/files) . Again, these links will give a 404 until after release, but it is the value of the links that is important. Docs: FN versions should be double-checked and same verbiage should be used for TN versions of the Guide.

      Description

      When the customer

      This is an issue we had when the manual wasn't in the truenas build, and now that we've removed it, we need this behavior back.

      On FreeNAS and TrueNAS, when the admin clicks to view the manual, it should give them a link to the specific build they are using. Mismatches between the installed version and the manual are not immediately obvious, and lead to customers asking questions of the support team because they see/don't see checkboxes that appear in the manual.

      For example, if I am running 11.1-U4, the manual version I should get should be for 11.1-U4 and nothing newer or older.

      This issue exists in FreeNAS at the moment as I just clicked on the manual, and while I'm running FreeNAS 11.2-U2.1, I got the manual for 11.2-U3. No doubt there have been changes, but those changes do not apply to me, and so I should not be pointed to an inappropriate manual.

      Thanks.

        Attachments

          Container Issues

            Activity

              People

              • Assignee:
                waqar Waqar Ahmed
                Reporter:
                joshua Joshua Sirrine
                QE Engineer:
                Dru Lavigne, Joe Maloney
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel