From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <s.sterz@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by lists.proxmox.com (Postfix) with ESMTPS id EFBED8D635
 for <pve-devel@lists.proxmox.com>; Tue,  8 Nov 2022 16:01:48 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id D83419DA1
 for <pve-devel@lists.proxmox.com>; Tue,  8 Nov 2022 16:01:48 +0100 (CET)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
 [94.136.29.106])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by firstgate.proxmox.com (Proxmox) with ESMTPS
 for <pve-devel@lists.proxmox.com>; Tue,  8 Nov 2022 16:01:47 +0100 (CET)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
 by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 472A04366A
 for <pve-devel@lists.proxmox.com>; Tue,  8 Nov 2022 16:01:47 +0100 (CET)
From: Stefan Sterz <s.sterz@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Tue,  8 Nov 2022 16:01:29 +0100
Message-Id: <20221108150130.2415229-1-s.sterz@proxmox.com>
X-Mailer: git-send-email 2.30.2
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.107 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: [pve-devel] [PATCH manager v1 1/2] fix #4328: make help buttons in
 the markdown editor window work again
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 08 Nov 2022 15:01:49 -0000

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