Arc - Help - ability for plugins to specify separate help-docs folder
Is your feature request related to a problem? Please describe.
At present the help system files need to reside under files/help-docs in the main Arc server folder. This means plugins can't provide their own help files because they don't have access to the main Arc server folder.
Describe the solution you'd like
The ability to load help files from the plugin's own folder: plugins/plugins/help-doc
.
Describe alternatives you've considered
Asking the Arc team to integrate help files for each plugin. This doesn't make much sense, as plugins are optionally installed, so including help for missing plugins would just bloat the app unnecessarily.
Additional context
Suggest the help system recognise when the help files array contains a plugin path. This way, plugins can fire up a help dialog by passing an array such as ['plugins/{pluginName}/{sectionName}', ...]
.
For example, the 'atmosphere' plugin could define it's help function as:
$scope.help = function () {
$dialogs.helpDialog([
'plugins/atmosphere/overview',
'plugins/atmosphere/page-2',
...
], 'ATMOSPHEREPORTALHELP');
};