[pve-devel] [PATCH manager] gui: fix firewall security group help button chapter link

[pve-devel] [PATCH manager] gui: fix firewall security group help button chapter link

[Daniel Tschlatscher]

The help button under Datacenter > Firewall > Security Group did not
have the proper help chapter link set.

First reported here:
https://forum.proxmox.com/threads/broken-help-link-in-proxmox-gui.117503/

Signed-off-by: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
---
I noticed that the onlineHelp field for our custom classes is
sometimes defined outside of the class, in the Config which defines
the layout of the navigation panel, and sometimes inside of the class
directly.
This time I added it inside the class, as it seems to be the more
commonly used thing. Though, is there any preference for this?


 www/manager6/dc/SecurityGroups.js | 1 +
 1 file changed, 1 insertion(+)

diff --git a/www/manager6/dc/SecurityGroups.js b/www/manager6/dc/SecurityGroups.js
index 5fb6860d..26172bf3 100644
--- a/www/manager6/dc/SecurityGroups.js
+++ b/www/manager6/dc/SecurityGroups.js
@@ -199,6 +199,7 @@ Ext.define('PVE.SecurityGroups', {
     alias: 'widget.pveSecurityGroups',
 
     title: 'Security Groups',
+    onlineHelp: 'pve_firewall_security_groups',
 
     layout: 'border',
 
-- 
2.30.2

[pve-devel] applied: [PATCH manager] gui: fix firewall security group help button chapter link

[Thomas Lamprecht]

Am 04/11/2022 um 10:18 schrieb Daniel Tschlatscher:
> The help button under Datacenter > Firewall > Security Group did not
> have the proper help chapter link set.
> 
> First reported here:
> https://forum.proxmox.com/threads/broken-help-link-in-proxmox-gui.117503/
> 
> Signed-off-by: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
> ---
> I noticed that the onlineHelp field for our custom classes is
> sometimes defined outside of the class, in the Config which defines
> the layout of the navigation panel, and sometimes inside of the class
> directly.
> This time I added it inside the class, as it seems to be the more
> commonly used thing. Though, is there any preference for this?
> 

meh, not using the class itself directly is mostly relevant for components where
there's either a different docs for different usages, albeit a) that is really
rare and b) that can be overridden too.

So no, basically no difference, and personally I'd say that declaring it in the
class itself keeps related information better together and visible, and thus
easier to keep in sync. The usage declaration in the Config modules should mostly
have properties declared that are relevant for the navigation/tab bar itself, not
the panel that gets shown if the menu/tab entry is actually selected.

> 
>  www/manager6/dc/SecurityGroups.js | 1 +
>  1 file changed, 1 insertion(+)
> 
>

applied, thanks!