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

[pve-devel] [PATCH manager v2 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.

History
=======

v1: https://lore.proxmox.com/pve-devel/20250528092927.253490-1-c.heiss@proxmox.com/

Changes v1 -> v2:
  * rebased on latest master

Diffstat
========

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 v2 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>
---
Changes v1 -> v2:
  * rebased on latest master

 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 64c518373..ba588edcd 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 v2 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>
---
Changes v1 -> v2:
  * rebased on latest master

 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 06905ce56..1bfa25a64 100644
--- a/www/manager6/qemu/HDTPM.js
+++ b/www/manager6/qemu/HDTPM.js
@@ -92,7 +92,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 v2 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>
---
Changes v1 -> v2:
  * rebased on latest master

 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 868526079..724b95cd3 100644
--- a/debian/control
+++ b/debian/control
@@ -86,7 +86,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 v2 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>
---
Changes v1 -> v2:
  * rebased on latest master

 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 20d74b6fb..c51d1e24a 100644
--- a/www/manager6/dc/OptionView.js
+++ b/www/manager6/dc/OptionView.js
@@ -403,7 +403,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 32d3032ea..29aefa286 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 f7a4decdb..9d0fe13b8 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

[pve-devel] applied-series: [PATCH manager v2 0/4] improve some onlineHelp links

[Thomas Lamprecht]

On Mon, 07 Jul 2025 11:14:06 +0200, 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.
> 
> [...]

Applied, thanks!

[1/4] ui: qemu: AudioEdit: enable online help link
      commit: 360dc6feebb6e34b8816872c592f8e7c8816a8cf
[2/4] ui: qemu: HDTPM: enable online help link
      commit: 15ce890fcc96178e2a84d4d3054245e41e1d53c1
[3/4] ui: panel: TagConfig: link to more specific online help section
      commit: b5943584129cb3283e1f25a65f4d982f037e40d1
[4/4] ui: dc: tag edit: use more specific documentation section
      commit: a209cd573395a79967dac98f3a1221b92861d14b


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