[pve-devel] [PATCH docs/manager/proxmox-widget-toolkit 0/4] notifications: add help buttons, linking to the appropriate sections

[pve-devel] [PATCH docs/manager/proxmox-widget-toolkit 0/4] notifications: add help buttons, linking to the appropriate sections

[Lukas Wagner]

Add help buttons for notification related UIs, linking to the appropriate
section in the documentation.

First patch for pve-manager fixes the build against the latest
pve-doc-generator package from the current git master. 

Requires pve-doc packages to be bumped (due to new section anchors)



pve-docs:

Lukas Wagner (1):
  notification: add anchors for target types/matchers

 notifications.adoc | 6 ++++++
 1 file changed, 6 insertions(+)


pve-manager:

Lukas Wagner (2):
  ui: sdn: fix onlineHelp anchors
  ui: dc: config: remove onlineHelp for notification config view

 www/manager6/dc/Config.js            | 1 -
 www/manager6/sdn/VnetPanel.js        | 2 +-
 www/manager6/sdn/VnetView.js         | 6 +++---
 www/manager6/sdn/ZoneContentPanel.js | 2 +-
 4 files changed, 5 insertions(+), 6 deletions(-)


proxmox-widget-toolkit:

Lukas Wagner (1):
  notification ui: add appropriate onlineHelp anchors

 src/panel/GotifyEditPanel.js          | 1 +
 src/panel/NotificationConfigView.js   | 1 +
 src/panel/SendmailEditPanel.js        | 1 +
 src/panel/SmtpEditPanel.js            | 1 +
 src/window/NotificationMatcherEdit.js | 1 +
 5 files changed, 5 insertions(+)


Summary over all repositories:
  10 files changed, 16 insertions(+), 6 deletions(-)

-- 
murpp v0.4.0

[pve-devel] [PATCH pve-docs 1/4] notification: add anchors for target types/matchers

[Lukas Wagner]

This enables us to directly link to the appropriate section from the
UI.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 notifications.adoc | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/notifications.adoc b/notifications.adoc
index 74447e5..21e13c4 100644
--- a/notifications.adoc
+++ b/notifications.adoc
@@ -39,6 +39,7 @@ passwords or authentication tokens for notification targets.
 Notification Targets
 --------------------
 
+[[notification_targets_sendmail]]
 Sendmail
 ~~~~~~~~
 The sendmail binary is a program commonly found on Unix-like operating systems
@@ -80,6 +81,7 @@ sendmail: example
         comment Send to multiple users/addresses
 ----
 
+[[notification_targets_smtp]]
 SMTP
 ~~~~
 
@@ -126,6 +128,7 @@ smtp: example
         password somepassword
 ----
 
+[[notification_targets_gotify]]
 Gotify
 ~~~~~~
 
@@ -196,6 +199,7 @@ a matcher must be true. Defaults to `all`.
 * `match-severity`: Match the notification's severity
 * `comment`: Comment for this matcher
 
+[[notification_matchers_calendar]]
 Calendar Matching Rules
 ~~~~~~~~~~~~~~~~~~~~~~~
 A calendar matcher matches the time when a notification is sent agaist a
@@ -206,6 +210,7 @@ configurable schedule.
 * `match-calendar mon-fri 9:00-17:00`
 * `match-calendar sun,tue-wed,fri 9-17`
 
+[[notification_matchers_field]]
 Field Matching Rules
 ~~~~~~~~~~~~~~~~~~~~
 Notifications have a selection of metadata fields that can be matched.
@@ -220,6 +225,7 @@ For instance, a `match-field regex:hostname=.*` directive will only match
 notifications that have an arbitraty `hostname` metadata field, but will
 not match if the field does not exist.
 
+[[notification_matchers_severity]]
 Severity Matching Rules
 ~~~~~~~~~~~~~~~~~~~~~~~
 A notification has a associated severity that can be matched.
-- 
2.39.2

[pve-devel] [PATCH pve-manager 2/4] ui: sdn: fix onlineHelp anchors

[Lukas Wagner]

These have been renamed in:
bcb72b 'sdn: overall language and consistency rework' in pve-docs

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 www/manager6/sdn/VnetPanel.js        | 2 +-
 www/manager6/sdn/VnetView.js         | 6 +++---
 www/manager6/sdn/ZoneContentPanel.js | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/www/manager6/sdn/VnetPanel.js b/www/manager6/sdn/VnetPanel.js
index b8377cbc..107ecc9b 100644
--- a/www/manager6/sdn/VnetPanel.js
+++ b/www/manager6/sdn/VnetPanel.js
@@ -4,7 +4,7 @@ Ext.define('PVE.sdn.Vnet', {
 
     title: 'VNet',
 
-    onlineHelp: 'pvesdn_config_vnet',
+    onlineHelp: 'pvesdn_config_vnets',
 
     initComponent: function() {
 	var me = this;
diff --git a/www/manager6/sdn/VnetView.js b/www/manager6/sdn/VnetView.js
index 3fd3c916..65e5c00a 100644
--- a/www/manager6/sdn/VnetView.js
+++ b/www/manager6/sdn/VnetView.js
@@ -2,7 +2,7 @@ Ext.define('PVE.sdn.VnetView', {
     extend: 'Ext.grid.GridPanel',
     alias: 'widget.pveSDNVnetView',
 
-    onlineHelp: 'pvesdn_config_vnet',
+    onlineHelp: 'pvesdn_config_vnets',
 
     stateful: true,
     stateId: 'grid-sdn-vnet',
@@ -33,7 +33,7 @@ Ext.define('PVE.sdn.VnetView', {
 
 	    let win = Ext.create('PVE.sdn.VnetEdit', {
 		autoShow: true,
-		onlineHelp: 'pvesdn_config_vnet',
+		onlineHelp: 'pvesdn_config_vnets',
 		vnet: rec.data.vnet,
 	    });
 	    win.on('destroy', reload);
@@ -74,7 +74,7 @@ Ext.define('PVE.sdn.VnetView', {
 		    handler: function() {
 			let win = Ext.create('PVE.sdn.VnetEdit', {
 			    autoShow: true,
-			    onlineHelp: 'pvesdn_config_vnet',
+			    onlineHelp: 'pvesdn_config_vnets',
 			    type: 'vnet',
 			});
 			win.on('destroy', reload);
diff --git a/www/manager6/sdn/ZoneContentPanel.js b/www/manager6/sdn/ZoneContentPanel.js
index b5c7f492..e9058f9a 100644
--- a/www/manager6/sdn/ZoneContentPanel.js
+++ b/www/manager6/sdn/ZoneContentPanel.js
@@ -4,7 +4,7 @@ Ext.define('PVE.sdn.ZoneContentPanel', {
 
     title: 'VNet',
 
-    onlineHelp: 'pvesdn_config_vnet',
+    onlineHelp: 'pvesdn_config_vnets',
 
     initComponent: function() {
 	var me = this;
-- 
2.39.2

[pve-devel] [PATCH pve-manager 3/4] ui: dc: config: remove onlineHelp for notification config view

[Lukas Wagner]

The 'onlineHelp' is now set in the component definition in
'proxmox-widget-toolkit'.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 www/manager6/dc/Config.js | 1 -
 1 file changed, 1 deletion(-)

diff --git a/www/manager6/dc/Config.js b/www/manager6/dc/Config.js
index 74a84e91..f22688f8 100644
--- a/www/manager6/dc/Config.js
+++ b/www/manager6/dc/Config.js
@@ -324,7 +324,6 @@ Ext.define('PVE.dc.Config', {
 		{
 		    xtype: 'pmxNotificationConfigView',
 		    title: gettext('Notifications'),
-		    onlineHelp: 'notification_targets',
 		    itemId: 'notification-targets',
 		    iconCls: 'fa fa-bell-o',
 		    baseUrl: '/cluster/notifications',
-- 
2.39.2

[pve-devel] [PATCH proxmox-widget-toolkit 4/4] notification ui: add appropriate onlineHelp anchors

[Lukas Wagner]

This links the dialog windows to the correct help section (different
target types, matchers).

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 src/panel/GotifyEditPanel.js          | 1 +
 src/panel/NotificationConfigView.js   | 1 +
 src/panel/SendmailEditPanel.js        | 1 +
 src/panel/SmtpEditPanel.js            | 1 +
 src/window/NotificationMatcherEdit.js | 1 +
 5 files changed, 5 insertions(+)

diff --git a/src/panel/GotifyEditPanel.js b/src/panel/GotifyEditPanel.js
index 7e6ecd8..0e8cac4 100644
--- a/src/panel/GotifyEditPanel.js
+++ b/src/panel/GotifyEditPanel.js
@@ -2,6 +2,7 @@ Ext.define('Proxmox.panel.GotifyEditPanel', {
     extend: 'Proxmox.panel.InputPanel',
     xtype: 'pmxGotifyEditPanel',
     mixins: ['Proxmox.Mixin.CBind'],
+    onlineHelp: 'notification_targets_gotify',
 
     type: 'gotify',
 
diff --git a/src/panel/NotificationConfigView.js b/src/panel/NotificationConfigView.js
index 4695da5..4d3ee46 100644
--- a/src/panel/NotificationConfigView.js
+++ b/src/panel/NotificationConfigView.js
@@ -2,6 +2,7 @@ Ext.define('Proxmox.panel.NotificationConfigView', {
     extend: 'Ext.panel.Panel',
     alias: 'widget.pmxNotificationConfigView',
     mixins: ['Proxmox.Mixin.CBind'],
+    onlineHelp: 'chapter_notifications',
     layout: {
 	type: 'border',
     },
diff --git a/src/panel/SendmailEditPanel.js b/src/panel/SendmailEditPanel.js
index b744787..5a154c1 100644
--- a/src/panel/SendmailEditPanel.js
+++ b/src/panel/SendmailEditPanel.js
@@ -4,6 +4,7 @@ Ext.define('Proxmox.panel.SendmailEditPanel', {
     mixins: ['Proxmox.Mixin.CBind'],
 
     type: 'sendmail',
+    onlineHelp: 'notification_targets_sendmail',
 
     mailValidator: function() {
 	let mailto_user = this.down(`[name=mailto-user]`);
diff --git a/src/panel/SmtpEditPanel.js b/src/panel/SmtpEditPanel.js
index 218485d..8b258e0 100644
--- a/src/panel/SmtpEditPanel.js
+++ b/src/panel/SmtpEditPanel.js
@@ -2,6 +2,7 @@ Ext.define('Proxmox.panel.SmtpEditPanel', {
     extend: 'Proxmox.panel.InputPanel',
     xtype: 'pmxSmtpEditPanel',
     mixins: ['Proxmox.Mixin.CBind'],
+    onlineHelp: 'notification_targets_smtp',
 
     type: 'smtp',
 
diff --git a/src/window/NotificationMatcherEdit.js b/src/window/NotificationMatcherEdit.js
index ee08c16..9ee34fd 100644
--- a/src/window/NotificationMatcherEdit.js
+++ b/src/window/NotificationMatcherEdit.js
@@ -73,6 +73,7 @@ Ext.define('Proxmox.window.NotificationMatcherEdit', {
     extend: 'Proxmox.window.Edit',
 
     isAdd: true,
+    onlineHelp: 'notification_matchers',
 
     fieldDefaults: {
 	labelWidth: 120,
-- 
2.39.2

[pve-devel] applied: [PATCH pve-docs 1/4] notification: add anchors for target types/matchers

[Thomas Lamprecht]

Am 21/11/2023 um 15:47 schrieb Lukas Wagner:
> This enables us to directly link to the appropriate section from the
> UI.
> 
> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
>  notifications.adoc | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
>

applied this one, needing a bump for the other ones, thanks!

Re: [pve-devel] [PATCH pve-manager 2/4] ui: sdn: fix onlineHelp anchors

[Thomas Lamprecht]

Am 21/11/2023 um 15:47 schrieb Lukas Wagner:
> These have been renamed in:
> bcb72b 'sdn: overall language and consistency rework' in pve-docs

I reverted that part in the docs before I saw you patch and will keep it that
way, IMO one should have good reasons to break links than just vnet vs vnets..

[pve-devel] applied: [PATCH pve-manager 3/4] ui: dc: config: remove onlineHelp for notification config view

[Thomas Lamprecht]

Am 21/11/2023 um 15:47 schrieb Lukas Wagner:
> The 'onlineHelp' is now set in the component definition in
> 'proxmox-widget-toolkit'.
> 
> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
>  www/manager6/dc/Config.js | 1 -
>  1 file changed, 1 deletion(-)
> 
>

applied, thanks!

[pve-devel] applied: [PATCH proxmox-widget-toolkit 4/4] notification ui: add appropriate onlineHelp anchors

[Thomas Lamprecht]

Am 21/11/2023 um 15:47 schrieb Lukas Wagner:
> This links the dialog windows to the correct help section (different
> target types, matchers).
> 
> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
>  src/panel/GotifyEditPanel.js          | 1 +
>  src/panel/NotificationConfigView.js   | 1 +
>  src/panel/SendmailEditPanel.js        | 1 +
>  src/panel/SmtpEditPanel.js            | 1 +
>  src/window/NotificationMatcherEdit.js | 1 +
>  5 files changed, 5 insertions(+)
> 
>

applied, thanks!