Project

General

Profile

Feature #75459

Add ability to navigate to documentation URL for iocage plugins

Added by Brandon Schneider 9 months ago. Updated 7 months ago.

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

Description

Copied from original MW ticket as that work is now done.
---
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 from FreeNAS - Feature #72323: Add ability to navigate to documentation URL for iocage pluginsDone

History

#1 Updated by Brandon Schneider 9 months ago

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

#2 Updated by Erin Clark 9 months ago

  • Assignee changed from Erin Clark to Lola Yang
  • Target version changed from Backlog to 11.3

#3 Avatar?id=14398&size=24x24 Updated by Kris Moore 7 months ago

  • Status changed from Unscreened to Closed

Also available in: Atom PDF