Project

General

Profile

Umbrella #54909

Avatar?id=14398&size=50x50

Unhook Guide from build system and link to online version

Added by Kris Moore over 1 year ago. Updated over 1 year ago.

Status:
Done
Priority:
No priority
Assignee:
Warren Block
Category:
Documentation
Target version:
Due date:
Reason for Closing:
Reason for Blocked:
Needs Doc:
No
Needs Automation:
No

Description

For 11.2 and beyond we'd like to move the docs to being "online" help only, with the option to download an offline PDF from the public website.

This ticket is to track the progress removing this from the Build, FreeNAS legacy UI and FreeNAS new UI.


Subtasks

Feature #54915: Remove docs build from FreeNAS buildDoneKris Moore
Feature #54924: Replace Docs links in Legacy UI to Online VersionDoneWilliam Grzybowski
Feature #54933: Replace Docs links in New UI to Online VersionClosedWarren Block

Related issues

Related to FreeNAS - Feature #46909: Replace doc.freenas.org with a Guide version menu selectorDone
Related to FreeNAS - Feature #55944: Add ability to define an online doc URL and version string and substitute them in help text/tooltipsDone
Related to FreeNAS - Bug #56742: When removing directories from a package, sort them in reverseDone
Related to FreeNAS - Bug #56979: Move logic for getting docstring version to navigation component and add version to Guide linkDone
Copied to FreeNAS - Feature #69382: Have Guide icon point to online version of GuideDone

History

#1 Updated by Dru Lavigne over 1 year ago

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

#2 Updated by Dru Lavigne over 1 year ago

  • Subject changed from Remove Docs from FreeNAS Build to Unhook Guide from build system and link to online version
  • Status changed from Unscreened to In Progress
  • Needs Doc changed from Yes to No

#3 Updated by Dru Lavigne over 1 year ago

  • Related to Feature #46909: Replace doc.freenas.org with a Guide version menu selector added

#4 Updated by Warren Block over 1 year ago

  • Assignee changed from Warren Block to William Grzybowski

The URL for the Guide link in the legacy UI is https://doc.freenas.org/11.2-legacy/

#6 Updated by Dru Lavigne over 1 year ago

  • Related to Feature #55944: Add ability to define an online doc URL and version string and substitute them in help text/tooltips added

#7 Updated by William Grzybowski over 1 year ago

  • Assignee changed from William Grzybowski to Warren Block

I am only responsible for #54924

#8 Updated by Dru Lavigne over 1 year ago

  • Related to Bug #56742: When removing directories from a package, sort them in reverse added

#9 Updated by Dru Lavigne over 1 year ago

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

#10 Updated by Dru Lavigne over 1 year ago

  • Status changed from In Progress to Done

#11 Updated by Dru Lavigne about 1 year ago

  • Copied to Feature #69382: Have Guide icon point to online version of Guide added

Also available in: Atom PDF