Search

Capturing my current thoughts on the help files for the external-workspace-manager plugin. We cannot assume the user will read the wiki even if they should.

External Workspace Definitions help files

• Disk Pool Display Name: is it really required?
• Disk Pool "Description" should say "Disk Pool Description" (drop the 's)
• Disk "Name" label should say "Display Name", same as Disk Pool "Display Name" for consistency
• Disk "Name": is it really required?
• "Master mount point" and "Physical path on disk": I think the second one needs to show how the default strategy concatenates them. To a novice user, the lack of information here could mean <physical path on disk>/<master mount point>, as the other way around.
• Physical path on disk: is it necessarily required?
• Physical path on disk: What if there is no additional path between the master mount point and the point of use on the disk? Some networks mount all disks exactly the same everywhere (and same as master).

Template help files

• The template itself needs a bit of a help file. It should say that when the node configuration is not found, the template is used (or is it the other way around?).
• It should also say whether a template is needed at all or not
• It should briefly describe why one would want to use an external workspace template (perhaps provide a use case)
• Label description: Say "Node label", drop the 's.
• Local root path: Say "The mounting point from this node to the disk being referred by the disk ref id.
• Local root path: Same as above: Some networks mount all disks exactly the same everywhere (and same as master).

Node help

• If a general help is possible, it should say the search order (first the template is searched, then the node is searched)
• It should also say that the node configuration is optional (if this is true)
• Local root path: It should say the mounting point from this node to the disk being referred by the disk ref id
• Local root path: Same as above: Some networks mount all disks exactly the same everywhere (and same as master).

Sorry this may not be the best place to capture these comments, so I'll move them to to github if I find a way.