public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stefan Sterz <s.sterz@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH manager v1 1/2] fix #4328: make help buttons in the markdown editor window work again
Date: Tue,  8 Nov 2022 16:01:29 +0100	[thread overview]
Message-ID: <20221108150130.2415229-1-s.sterz@proxmox.com> (raw)

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





             reply	other threads:[~2022-11-08 15:01 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-08 15:01 Stefan Sterz [this message]
2022-11-08 15:01 ` [pve-devel] [PATCH manager v1 2/2] ui: add javascript source to `OnlineHelpInfo.js` prerequisites Stefan Sterz
2022-11-08 15:28   ` [pve-devel] applied: " Thomas Lamprecht
2022-11-08 15:31 ` [pve-devel] [PATCH manager v1 1/2] fix #4328: make help buttons in the markdown editor window work again Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221108150130.2415229-1-s.sterz@proxmox.com \
    --to=s.sterz@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal