[pve-devel] [PATCH manager v1 1/2] fix #4328: make help buttons in the markdown editor window work again

[pve-devel] [PATCH manager v1 1/2] fix #4328: make help buttons in the markdown editor window work again

[Stefan Sterz]

when the `onlineHelp` of a component is defined in the widget toolkit
`asciidoc-pve` can't pick up on that and `OnlineHelpInfo.js` won't
contain the necessary keys. this patch sets `onlineHelp` in this
package again to avoid that.

note: technically it would be enough to set this for one of the three
usages of `pmxNotesView`, as then `asciidoc-pve` would add it to
`OnlineHelpInfo.js` again. however, for consistency's sake i added it
to all occurrences.

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
---
so this issue doesn't only affect the markdown notes, there are also
other components affected by this. afict this includes:

* `proxmoxNodeNetworkView`: needs `sysadmin_network_configuration`,
  which works because it is also set in `node/Config.js`, similar to
  this fix.
* several components related to tfa need `user_mgmt` which are all
  currently broken, because that key isn't used at all in
  `pve-manager`.

i think it would be nice to have a solution that allows setting such
keys in the widget toolkit only, but that would require one of two
changes:

1. always add all possible keys to `OnlineHelpInfo.js`. to my
   understanding, this is similar to how pbs currently creates its
   `OnlineHelpInfo.js`
2. include the widget toolkit's javascript files in the input to
   `asciidoc-pve`. however, i am unsure how we could do so elegantly.

 www/manager6/dc/Config.js          | 1 +
 www/manager6/node/Config.js        | 1 +
 www/manager6/panel/GuestSummary.js | 1 +
 3 files changed, 3 insertions(+)

diff --git a/www/manager6/dc/Config.js b/www/manager6/dc/Config.js
index 13ded12e..4da47e43 100644
--- a/www/manager6/dc/Config.js
+++ b/www/manager6/dc/Config.js
@@ -32,6 +32,7 @@ Ext.define('PVE.dc.Config', {
 		title: gettext('Notes'),
 		iconCls: 'fa fa-sticky-note-o',
 		itemId: 'notes',
+		onlineHelp: 'markdown_basics',
 	    },
 	    {
 		title: gettext('Cluster'),
diff --git a/www/manager6/node/Config.js b/www/manager6/node/Config.js
index 7e5b1112..9959aea6 100644
--- a/www/manager6/node/Config.js
+++ b/www/manager6/node/Config.js
@@ -133,6 +133,7 @@ Ext.define('PVE.node.Config', {
 		    title: gettext('Notes'),
 		    iconCls: 'fa fa-sticky-note-o',
 		    itemId: 'notes',
+		    onlineHelp: 'markdown_basics',
 		},
 	    );
 	}
diff --git a/www/manager6/panel/GuestSummary.js b/www/manager6/panel/GuestSummary.js
index 1565db3f..6b6c4298 100644
--- a/www/manager6/panel/GuestSummary.js
+++ b/www/manager6/panel/GuestSummary.js
@@ -45,6 +45,7 @@ Ext.define('PVE.guest.Summary', {
 		padding: template ? '5' : '0 0 0 5',
 		itemId: 'notesview',
 		pveSelNode: me.pveSelNode,
+		onlineHelp: 'markdown_basics',
 	    },
 	];
 
-- 
2.30.2

[pve-devel] [PATCH manager v1 2/2] ui: add javascript source to `OnlineHelpInfo.js` prerequisites

[Stefan Sterz]

by adding the javascript files as prerequisites, the
`OnlineHelpInfo.js` will get re-generated if a new `onlineHelp` key
is used. thus, this avoids an issue were valid keys might not get
mapped correctly because the info in `OnlineHelpInfo.js` wasn't
updated.

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
---
i stubled accross while fixing the bug mentioned in the previous 
commit. feel free to drop this, though.

 www/manager6/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/www/manager6/Makefile b/www/manager6/Makefile
index d16770b1..5938c7f5 100644
--- a/www/manager6/Makefile
+++ b/www/manager6/Makefile
@@ -304,7 +304,7 @@ pvemanagerlib.js: .lint-incremental OnlineHelpInfo.js ${JSSRC}
 	cat OnlineHelpInfo.js ${JSSRC} >$@.tmp
 	mv $@.tmp $@
 
-OnlineHelpInfo.js: /usr/bin/asciidoc-pve
+OnlineHelpInfo.js: /usr/bin/asciidoc-pve ${JSSRC}
 	/usr/bin/asciidoc-pve scan-extjs ${JSSRC} >$@.tmp
 	mv $@.tmp $@
 
-- 
2.30.2

[pve-devel] applied: [PATCH manager v1 2/2] ui: add javascript source to `OnlineHelpInfo.js` prerequisites

[Thomas Lamprecht]

Am 08/11/2022 um 16:01 schrieb Stefan Sterz:
> by adding the javascript files as prerequisites, the
> `OnlineHelpInfo.js` will get re-generated if a new `onlineHelp` key
> is used. thus, this avoids an issue were valid keys might not get
> mapped correctly because the info in `OnlineHelpInfo.js` wasn't
> updated.
> 
> Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
> ---
> i stubled accross while fixing the bug mentioned in the previous 
> commit. feel free to drop this, though.
> 
>  www/manager6/Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
>

applied, thanks!

Re: [pve-devel] [PATCH manager v1 1/2] fix #4328: make help buttons in the markdown editor window work again

[Thomas Lamprecht]

Am 08/11/2022 um 16:01 schrieb Stefan Sterz:
> when the `onlineHelp` of a component is defined in the widget toolkit
> `asciidoc-pve` can't pick up on that and `OnlineHelpInfo.js` won't
> contain the necessary keys. this patch sets `onlineHelp` in this
> package again to avoid that.
> 
> note: technically it would be enough to set this for one of the three
> usages of `pmxNotesView`, as then `asciidoc-pve` would add it to
> `OnlineHelpInfo.js` again. however, for consistency's sake i added it
> to all occurrences.
> 
> Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
> ---
> so this issue doesn't only affect the markdown notes, there are also
> other components affected by this. afict this includes:
> 
> * `proxmoxNodeNetworkView`: needs `sysadmin_network_configuration`,
>   which works because it is also set in `node/Config.js`, similar to
>   this fix.
> * several components related to tfa need `user_mgmt` which are all
>   currently broken, because that key isn't used at all in
>   `pve-manager`.
> 
> i think it would be nice to have a solution that allows setting such
> keys in the widget toolkit only, but that would require one of two
> changes:
> 
> 1. always add all possible keys to `OnlineHelpInfo.js`. to my
>    understanding, this is similar to how pbs currently creates its
>    `OnlineHelpInfo.js`
> 2. include the widget toolkit's javascript files in the input to
>    `asciidoc-pve`. however, i am unsure how we could do so elegantly.

 please go for 2., I'd do so by adding proxmox-widget-toolkit to the
 Build-Depends list in d/control and parse it from the file at
 /usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js