[pve-devel] [PATCH manager 0/4] improve some onlineHelp links

[pve-devel] [PATCH manager 0/4] improve some onlineHelp links

[Christoph Heiss]

Came across these commented-out `onlineHelp` and looked into it - all
referenced sections across the repo have been (very) long available in
pve-docs and can thus be enabled.

Additionally, after looking at #3, thought to link to this "new" section
in some other tags-related panels, instead of the datacenter
configuration file.

Christoph Heiss (4):
  ui: qemu: AudioEdit: enable online help link
  ui: qemu: HDTPM: enable online help link
  ui: panel: TagConfig: link to more specific online help section
  ui: dc: tag edit: use more specific documentation section

 debian/control                        | 2 +-
 www/manager6/dc/OptionView.js         | 2 +-
 www/manager6/dc/RegisteredTagsEdit.js | 2 +-
 www/manager6/dc/UserTagAccessEdit.js  | 2 +-
 www/manager6/panel/TagConfig.js       | 3 +--
 www/manager6/qemu/AudioEdit.js        | 3 +--
 www/manager6/qemu/HDTPM.js            | 2 +-
 7 files changed, 7 insertions(+), 9 deletions(-)

-- 
2.49.0



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH manager 1/4] ui: qemu: AudioEdit: enable online help link

[Christoph Heiss]

This section has been available since pve-docs 6.0-5, which was released
in October 2019.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
 www/manager6/qemu/AudioEdit.js | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/www/manager6/qemu/AudioEdit.js b/www/manager6/qemu/AudioEdit.js
index e7861ceb9..ece3abf67 100644
--- a/www/manager6/qemu/AudioEdit.js
+++ b/www/manager6/qemu/AudioEdit.js
@@ -2,8 +2,7 @@ Ext.define('PVE.qemu.AudioInputPanel', {
     extend: 'Proxmox.panel.InputPanel',
     xtype: 'pveAudioInputPanel',
 
-    // FIXME: enable once we bumped doc-gen so this ref is included
-    //onlineHelp: 'qm_audio_device',
+    onlineHelp: 'qm_audio_device',
 
     onGetValues: function(values) {
 	var ret = PVE.Parser.printPropertyString(values);
-- 
2.49.0



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH manager 2/4] ui: qemu: HDTPM: enable online help link

[Christoph Heiss]

This section is available since pve-docs 7.1-1, which was released in
November 2021.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
 www/manager6/qemu/HDTPM.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/www/manager6/qemu/HDTPM.js b/www/manager6/qemu/HDTPM.js
index 87349aedb..dac3bb5ec 100644
--- a/www/manager6/qemu/HDTPM.js
+++ b/www/manager6/qemu/HDTPM.js
@@ -91,7 +91,7 @@ Ext.define('PVE.qemu.TPMDiskEdit', {
 
 	me.items = [{
 	    xtype: 'pveTPMDiskInputPanel',
-	    //onlineHelp: 'qm_tpm', FIXME: add once available
+	    onlineHelp: 'qm_tpm',
 	    confid: me.confid,
 	    nodename: nodename,
 	    isCreate: true,
-- 
2.49.0



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH manager 3/4] ui: panel: TagConfig: link to more specific online help section

[Christoph Heiss]

This section is available since pve-docs 8.2.4, released November 2024.
Includes the necessary bump to accommodate that.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
Hopefully the bump is okay as-is, but feel free to adjust as needed.

 debian/control                  | 2 +-
 www/manager6/panel/TagConfig.js | 3 +--
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/debian/control b/debian/control
index 7003f28be..d4a0bc887 100644
--- a/debian/control
+++ b/debian/control
@@ -85,7 +85,7 @@ Depends: apt (>= 1.5~),
          proxmox-widget-toolkit (>= 4.3.5),
          pve-cluster (>= 8.0.5),
          pve-container (>= 5.2.5),
-         pve-docs (>= 8.0~~),
+         pve-docs (>= 8.2.4),
          pve-firewall,
          pve-ha-manager,
          pve-i18n (>= 3.2.0~),
diff --git a/www/manager6/panel/TagConfig.js b/www/manager6/panel/TagConfig.js
index 1ddbafd75..203c47c2e 100644
--- a/www/manager6/panel/TagConfig.js
+++ b/www/manager6/panel/TagConfig.js
@@ -2,6 +2,5 @@ Ext.define('PVE.panel.TagConfig', {
     extend: 'PVE.panel.Config',
     alias: 'widget.pveTagConfig',
 
-    //onlineHelp: 'gui_tags', // TODO: use this one once available
-    onlineHelp: 'chapter_gui',
+    onlineHelp: 'gui_tags',
 });
-- 
2.49.0



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH manager 4/4] ui: dc: tag edit: use more specific documentation section

[Christoph Heiss]

Now that there is a dedicated section for configuring tags, link to that
instead of to the documentation of the datacenter configuration file.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
 www/manager6/dc/OptionView.js         | 2 +-
 www/manager6/dc/RegisteredTagsEdit.js | 2 +-
 www/manager6/dc/UserTagAccessEdit.js  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/www/manager6/dc/OptionView.js b/www/manager6/dc/OptionView.js
index 930500a61..d37bef3c1 100644
--- a/www/manager6/dc/OptionView.js
+++ b/www/manager6/dc/OptionView.js
@@ -370,7 +370,7 @@ Ext.define('PVE.dc.OptionView', {
 		xtype: 'proxmoxWindowEdit',
 		width: 800,
 		subject: gettext('Tag Color Override'),
-		onlineHelp: 'datacenter_configuration_file',
+		onlineHelp: 'gui_tags',
 		fieldDefaults: {
 		    labelWidth: 100,
 		},
diff --git a/www/manager6/dc/RegisteredTagsEdit.js b/www/manager6/dc/RegisteredTagsEdit.js
index b46326ae8..c3ad929b0 100644
--- a/www/manager6/dc/RegisteredTagsEdit.js
+++ b/www/manager6/dc/RegisteredTagsEdit.js
@@ -3,7 +3,7 @@ Ext.define('PVE.dc.RegisteredTagsEdit', {
     alias: 'widget.pveRegisteredTagEdit',
 
     subject: gettext('Registered Tags'),
-    onlineHelp: 'datacenter_configuration_file',
+    onlineHelp: 'gui_tags',
 
     url: '/api2/extjs/cluster/options',
 
diff --git a/www/manager6/dc/UserTagAccessEdit.js b/www/manager6/dc/UserTagAccessEdit.js
index 61c38c074..d9ef3f9cc 100644
--- a/www/manager6/dc/UserTagAccessEdit.js
+++ b/www/manager6/dc/UserTagAccessEdit.js
@@ -3,7 +3,7 @@ Ext.define('PVE.dc.UserTagAccessEdit', {
     alias: 'widget.pveUserTagAccessEdit',
 
     subject: gettext('User Tag Access'),
-    onlineHelp: 'datacenter_configuration_file',
+    onlineHelp: 'gui_tags',
 
     url: '/api2/extjs/cluster/options',
 
-- 
2.49.0



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

Re: [pve-devel] [PATCH manager 0/4] improve some onlineHelp links

[Christoph Heiss]

v2: https://lore.proxmox.com/pve-devel/20250707091412.314631-1-c.heiss@proxmox.com/

On Wed May 28, 2025 at 11:29 AM CEST, Christoph Heiss wrote:
> Came across these commented-out `onlineHelp` and looked into it - all
> referenced sections across the repo have been (very) long available in
> pve-docs and can thus be enabled.
>
> Additionally, after looking at #3, thought to link to this "new" section
> in some other tags-related panels, instead of the datacenter
> configuration file.
>
> Christoph Heiss (4):
>   ui: qemu: AudioEdit: enable online help link
>   ui: qemu: HDTPM: enable online help link
>   ui: panel: TagConfig: link to more specific online help section
>   ui: dc: tag edit: use more specific documentation section
>
>  debian/control                        | 2 +-
>  www/manager6/dc/OptionView.js         | 2 +-
>  www/manager6/dc/RegisteredTagsEdit.js | 2 +-
>  www/manager6/dc/UserTagAccessEdit.js  | 2 +-
>  www/manager6/panel/TagConfig.js       | 3 +--
>  www/manager6/qemu/AudioEdit.js        | 3 +--
>  www/manager6/qemu/HDTPM.js            | 2 +-
>  7 files changed, 7 insertions(+), 9 deletions(-)



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel