Project

General

Profile

Feature #55944

Add ability to define an online doc URL and version string and substitute them in help text/tooltips

Added by Warren Block over 1 year ago. Updated over 1 year ago.

Status:
Done
Priority:
No priority
Assignee:
Erin Clark
Category:
GUI (new)
Target version:
Estimated time:
Severity:
High
Reason for Closing:
Reason for Blocked:
Needs QA:
Yes
Needs Doc:
No
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:

Description

We need a way to define an online doc URL globally and then use it in tooltips. For example, from src/app/pages/jails/jail-shell/jail-shell.component.ts:

  public shell_tooltip = T('<b>Ctrl+C</b> kills a foreground process.<br>\
                            Many utilities are built-in:<br> b>Iperf</b>,\
                            <b>Netperf</b>, <b>IOzone</b>, <b>arcsat</b>,\
                            <b>tw_cli</b>, <br><b>MegaCli</b>,\
                            <b>freenas-debug</b>, <b>tmux</b>,\
                            <b>Dmidecode</b>.<br> Refer to the <a\
                            href="..//docs/cli.html"\
                            target="_blank">Command Line Utilities</a>\
                            chapter in the guide for usage information\
                            and examples.');

In the link, we need to be able to refer to a constant or variable with the base online document URL. For example, if "docurl" is "https://doc.freenas.org/11.2":

href="%%docurl%%/cli.html" 

We would also like to add a value to indicate the version being run by the user. This would be set by the system. So if "runningversion" is "FreeNAS-11.2-RELEASE":

href="%%docurl%%/cli.html?running=%%runningversion%%" 

Related issues

Related to FreeNAS - Umbrella #54909: Unhook Guide from build system and link to online versionDone
Related to FreeNAS - Bug #56979: Move logic for getting docstring version to navigation component and add version to Guide linkDone
Related to FreeNAS - Bug #57825: Put anchors at end of generated URLsDone
Has duplicate FreeNAS - Feature #54933: Replace Docs links in New UI to Online VersionClosed
Copied to FreeNAS - Feature #57816: Fix anchors in GuideClosed

Associated revisions

Revision e1ef139f (diff)
Added by Erin Clark over 1 year ago

Initial commit to add online doc url Ticket: #55944

Revision 3ef44568 (diff)
Added by Erin Clark over 1 year ago

Fix URL to be the proper URL, also add capability for adding running version to URL Ticket: #55944

Revision 4bc147e3 (diff)
Added by Erin Clark over 1 year ago

Initial commit to add online doc url Ticket: #55944

Revision 74e391b3 (diff)
Added by Erin Clark over 1 year ago

Fix URL to be the proper URL, also add capability for adding running version to URL Ticket: #55944

Revision 15248f4c (diff)
Added by Erin Clark over 1 year ago

Remove trailing space so that can be done in the tooltip instead Ticket: #55944

Revision 75824dfe (diff)
Added by Erin Clark over 1 year ago

Remove trailing space so that can be done in the tooltip instead Ticket: #55944

Revision 904a15aa (diff)
Added by Erin Clark over 1 year ago

Decouple query from runningversion Ticket: #55944

Revision eefaa881 (diff)
Added by Erin Clark over 1 year ago

Decouple query from runningversion Ticket: #55944

Revision 0de45efa (diff)
Added by Erin Clark over 1 year ago

Reimplement doc url replace as a pipe to make it translate friendly Ticket: #55944

Revision c1f1fa55 (diff)
Added by Erin Clark over 1 year ago

Reimplement doc url replace as a pipe to make it translate friendly Ticket: #55944

Revision d8a8dcf4 (diff)
Added by Erin Clark over 1 year ago

Parse out version and add webversion keyword Ticket: #55944

Revision bd483da3 (diff)
Added by Erin Clark over 1 year ago

Parse out version and add webversion keyword Ticket: #55944

Revision 32a97af9 (diff)
Added by Erin Clark over 1 year ago

Adjust doc URL to the soon to be new proper URL Ticket: #55944

Revision cbaa03ec (diff)
Added by Erin Clark over 1 year ago

Adjust doc URL to the soon to be new proper URL Ticket: #55944

Revision 5a690ea4 (diff)
Added by Erin Clark over 1 year ago

Whoops Ticket: #55944

Revision 314f3171 (diff)
Added by Erin Clark over 1 year ago

Whoops Ticket: #55944

Revision cf5c827d (diff)
Added by Warren Block over 1 year ago

Update help strings to use new replacements Ticket: #55944

Revision f3c9ce0c (diff)
Added by Erin Clark over 1 year ago

Move doc replace function into its own service and adjust navigation to guide to use it to get the proper URL Ticket: #55944

Revision 23b105f8 (diff)
Added by Erin Clark over 1 year ago

Undo changes to guide component, this isn't being used by the navigation service currently Ticket: #55944

Revision 3d99e696 (diff)
Added by Warren Block over 1 year ago

Update help strings to use new replacements Ticket: #55944 (cherry picked from commit cf5c827dd4d459f1694b4eea6a4aadeed007f7ef)

Revision a332f426 (diff)
Added by Erin Clark over 1 year ago

Move doc replace function into its own service and adjust navigation to guide to use it to get the proper URL Ticket: #55944 (cherry picked from commit f3c9ce0c8ba3d1e5caf75fe830688e64d3f33869)

Revision f1b7f10f (diff)
Added by Erin Clark over 1 year ago

Undo changes to guide component, this isn't being used by the navigation service currently Ticket: #55944 (cherry picked from commit 23b105f81aa243318c4ac0059de86a9cf5ffc707)

Revision 827a38ee (diff)
Added by Erin Clark over 1 year ago

Move fetching of version to the service instead of the admin-layout (fixes it in Chrome) Ticket: #55944

Revision 9f892606 (diff)
Added by Erin Clark over 1 year ago

Move fetching of version to the service instead of the admin-layout (fixes it in Chrome) Ticket: #55944 (cherry picked from commit 827a38ee4b9ff5c78a247f1e4305ae7cbe5a2e3e)

Revision 16fdb344 (diff)
Added by Erin Clark over 1 year ago

Just realized the replacement wasn't global, this fixes multiple links in tooltips Ticket: #55944

Revision 7d42858b (diff)
Added by Erin Clark over 1 year ago

Just realized the replacement wasn't global, this fixes multiple links in tooltips Ticket: #55944 (cherry picked from commit 16fdb3443f788b67617c83a8c2047aa131c7730d)

Revision ca58091f (diff)
Added by Erin Clark over 1 year ago

Move logic for getting docstring version to navigation component and add webversion to guide url Ticket: #56979 #55944

Revision 11dfcd50 (diff)
Added by Erin Clark over 1 year ago

Move logic for getting docstring version to navigation component and add webversion to guide url Ticket: #56979 #55944 (cherry picked from commit ca58091f9944611ea888555076830779b2409e72)

History

#1 Updated by Dru Lavigne over 1 year ago

  • Target version changed from Master - FreeNAS Nightlies to 11.2-RC2
  • Severity changed from New to High

#2 Updated by Dru Lavigne over 1 year ago

  • Related to Umbrella #54909: Unhook Guide from build system and link to online version added

#3 Updated by Erin Clark over 1 year ago

  • Status changed from Unscreened to In Progress

#4 Updated by Erin Clark over 1 year ago

  • Status changed from In Progress to Ready for Testing

#5 Updated by Dru Lavigne over 1 year ago

  • Subject changed from Add ability to define an online doc URL and version string and substitute them in help text/tool tips to Add ability to define an online doc URL and version string and substitute them in help text/tooltips
  • Needs Doc changed from Yes to No
  • Needs Merging changed from Yes to No

#6 Updated by Bonnie Follweiler over 1 year ago

  • Status changed from Ready for Testing to Blocked
  • Reason for Blocked set to Dependent on a related task to be completed

Waiting on #54509 to be Ready For Testing. Currently the Guide is going to a broken URL so we can't check it

#8 Updated by Dru Lavigne over 1 year ago

  • Has duplicate Feature #54933: Replace Docs links in New UI to Online Version added

#9 Updated by Dru Lavigne over 1 year ago

  • Status changed from Blocked to Ready for Testing
  • Reason for Blocked deleted (Dependent on a related task to be completed)

#11 Updated by Erin Clark over 1 year ago

  • Related to Bug #56979: Move logic for getting docstring version to navigation component and add version to Guide link added

#12 Updated by Jeff Ervin over 1 year ago

40635
40644

Test Failed FreeNAS-11.2-INTERNAL49

Not being directed to the correct area of the guide (anchor is in the wrong area, needs to go last)

#13 Updated by Dru Lavigne over 1 year ago

  • Status changed from Failed Testing to Done

Warren will create a related ticket for RELEASE to fix the anchor issue.

#14 Updated by Dru Lavigne over 1 year ago

#15 Updated by Warren Block over 1 year ago

  • Related to Bug #57825: Put anchors at end of generated URLs added

Also available in: Atom PDF