Project

General

Profile

Feature #72323

Add ability to navigate to documentation URL for iocage plugins

Added by Jurgen Segaert 11 months ago. Updated 8 months ago.

Status:
Done
Priority:
No priority
Assignee:
Brandon Schneider
Category:
Middleware
Target version:
Estimated time:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
No
Needs Doc:
No
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:

Description

There is currently no way for a plugin developer to provide a link to any documentation on how to use and/or configure a plugin. The only option is to add some information in the post install notes, and this just provides a small pop-up for notes in plain text format.

It would be great to provide an option to add a URL that points to e.g. the plugin's website or the GitHub's readme.md (or even be hosted in the jail itself) and provide a way to navigate to this URL from within the new UI. If a documentation URL is specified, an additional menu-option would show in the context menu of the Plugins>Installed screen

I imagine this to work very similar to the adminportal URL one can provide in ui.json


Related issues

Copied to FreeNAS - Feature #75459: Add ability to navigate to documentation URL for iocage pluginsClosed

History

#1 Updated by Dru Lavigne 11 months ago

  • Category changed from Build system to Middleware
  • Assignee changed from Release Council to Brandon Schneider

#2 Updated by Brandon Schneider 11 months ago

  • Status changed from Unscreened to Not Started

#3 Updated by Bug Clerk 10 months ago

  • Status changed from Not Started to In Progress

#4 Updated by Bug Clerk 10 months ago

  • Status changed from In Progress to Ready for Testing

#5 Updated by Brandon Schneider 10 months ago

Not testable via GUI currently

#6 Updated by Brandon Schneider 10 months ago

  • Copied to Feature #75459: Add ability to navigate to documentation URL for iocage plugins added

#7 Updated by Dru Lavigne 10 months ago

  • Status changed from Ready for Testing to Done
  • Target version changed from Backlog to 11.3-BETA1
  • Needs QA changed from Yes to No
  • Needs Doc changed from Yes to No
  • Needs Merging changed from Yes to No

#8 Updated by Dru Lavigne 8 months ago

  • Target version changed from 11.3-BETA1 to 11.3-ALPHA1

Also available in: Atom PDF