[pve-devel] [PATCH proxmox-backup 0/5] add/fix help buttons

[pve-devel] [PATCH proxmox-backup 0/5] add/fix help buttons

[Aaron Lauterer]

The following series does the following:
* adds more help buttons where appropriate
* fixes not working help buttons
    * by adding more references where needed
    * changing the scanrefs script to add all references found in the
      docs as it would not add references needed in the widget toolkit
      in its current state. Something we will need to take another look
      at in the future.
    * fixing references in the docs/ui to match

In order for all the help buttons to work, the recent patch in the
widget-toolkit which fixed the dash/underscore normalization needs to be
applied [0].


[0] https://lists.proxmox.com/pipermail/pve-devel/2020-November/045868.html

Aaron Lauterer (5):
  scanrefs: only scan docs, not JS files
  docs: add maintenance chapter prefix to verification ref
  docs: add network management reference
  ui: add all online help refs found in docs
  ui: add/fix help buttons

 docs/_ext/proxmox-scanrefs.py | 25 ++++++++++--------
 docs/gui.rst                  |  2 +-
 docs/maintenance.rst          |  2 +-
 docs/network-management.rst   |  2 ++
 www/OnlineHelpInfo.js         | 48 +++++++++++++++++++++++++++++++++++
 www/datastore/PruneAndGC.js   |  2 ++
 www/window/CreateDirectory.js |  2 ++
 www/window/TokenEdit.js       |  2 +-
 www/window/VerifyJobEdit.js   |  2 +-
 9 files changed, 73 insertions(+), 14 deletions(-)

-- 
2.20.1

[pve-devel] [PATCH proxmox-backup 1/5] scanrefs: only scan docs, not JS files

[Aaron Lauterer]

This is a temporary hack until we find a sensible way to scan the
proxmox-widget-toolkit JS files as well.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
 docs/_ext/proxmox-scanrefs.py | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/docs/_ext/proxmox-scanrefs.py b/docs/_ext/proxmox-scanrefs.py
index 8de17620..10aaeed4 100644
--- a/docs/_ext/proxmox-scanrefs.py
+++ b/docs/_ext/proxmox-scanrefs.py
@@ -73,7 +73,9 @@ class ReflabelMapper(Builder):
             'link': '/docs/index.html',
             'title': 'Proxmox Backup Server Documentation Index',
         }
-        self.env.used_anchors = scan_extjs_files()
+        # Disabled until we find a sensible way to scan proxmox-widget-toolkit
+        # as well
+        #self.env.used_anchors = scan_extjs_files()
 
         if not os.path.isdir(self.outdir):
             os.mkdir(self.outdir)
@@ -115,15 +117,18 @@ class ReflabelMapper(Builder):
     def validate_anchors(self):
         #pprint(self.env.online_help)
         to_remove = []
-        for anchor in self.env.used_anchors:
-            if anchor not in self.env.online_help:
-                logger.info("[-] anchor {} is missing from onlinehelp!".format(anchor))
-        for anchor in self.env.online_help:
-            if anchor not in self.env.used_anchors and anchor != 'pbs_documentation_index':
-                logger.info("[*] anchor {} not used! deleting...".format(anchor))
-                to_remove.append(anchor)
-        for anchor in to_remove:
-            self.env.online_help.pop(anchor, None)
+
+        # Disabled until we find a sensible way to scan proxmox-widget-toolkit
+        # as well
+        #for anchor in self.env.used_anchors:
+        #    if anchor not in self.env.online_help:
+        #        logger.info("[-] anchor {} is missing from onlinehelp!".format(anchor))
+        #for anchor in self.env.online_help:
+        #    if anchor not in self.env.used_anchors and anchor != 'pbs_documentation_index':
+        #        logger.info("[*] anchor {} not used! deleting...".format(anchor))
+        #        to_remove.append(anchor)
+        #for anchor in to_remove:
+        #   self.env.online_help.pop(anchor, None)
         return
 
     def finish(self):
-- 
2.20.1

[pve-devel] [PATCH proxmox-backup 2/5] docs: add maintenance chapter prefix to verification ref

[Aaron Lauterer]

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
 docs/gui.rst         | 2 +-
 docs/maintenance.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/gui.rst b/docs/gui.rst
index d5b7e1bd..b2b1fb73 100644
--- a/docs/gui.rst
+++ b/docs/gui.rst
@@ -132,5 +132,5 @@ top panel to view:
   collection <garbage-collection>` operations, and run garbage collection
   manually
 * **Sync Jobs**: Create, manage and run :ref:`syncjobs` from remote servers
-* **Verify Jobs**: Create, manage and run :ref:`verification` jobs on the
+* **Verify Jobs**: Create, manage and run :ref:`maintenance_verification` jobs on the
   datastore
diff --git a/docs/maintenance.rst b/docs/maintenance.rst
index 1f3f129b..addc1b25 100644
--- a/docs/maintenance.rst
+++ b/docs/maintenance.rst
@@ -93,7 +93,7 @@ GC** from the top panel. From here, you can edit the schedule at which garbage
 collection runs and manually start the operation.
 
 
-.. _verification:
+.. _maintenance_verification:
 
 Verification
 ------------
-- 
2.20.1

[pve-devel] [PATCH proxmox-backup 3/5] docs: add network management reference

[Aaron Lauterer]

needed in order for the help button in the network edit window to work.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
 docs/network-management.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/network-management.rst b/docs/network-management.rst
index c6288c33..4b7ac75d 100644
--- a/docs/network-management.rst
+++ b/docs/network-management.rst
@@ -1,3 +1,5 @@
+.. _sysadmin_network_configuration:
+
 Network Management
 ==================
 
-- 
2.20.1

[pve-devel] [PATCH proxmox-backup 4/5] ui: add all online help refs found in docs

[Aaron Lauterer]

recommit the onlinehelp after the scanrefs script has been adapted and
the docs are up to date

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
 www/OnlineHelpInfo.js | 48 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/www/OnlineHelpInfo.js b/www/OnlineHelpInfo.js
index e83e0818..c6c3e06d 100644
--- a/www/OnlineHelpInfo.js
+++ b/www/OnlineHelpInfo.js
@@ -3,18 +3,54 @@ const proxmoxOnlineHelpInfo = {
     "link": "/docs/index.html",
     "title": "Proxmox Backup Server Documentation Index"
   },
+  "id1": {
+    "link": "/docs/calendarevents.html#id1",
+    "title": "Calendar Events"
+  },
+  "id2": {
+    "link": "/docs/backup-client.html#id2",
+    "title": "Encryption"
+  },
+  "changing-backup-owner": {
+    "link": "/docs/backup-client.html#changing-backup-owner",
+    "title": "Changing the Owner of a Backup Group"
+  },
   "backup-pruning": {
     "link": "/docs/backup-client.html#backup-pruning",
     "title": "Pruning and Removing Backups"
   },
+  "id3": {
+    "link": "/docs/backup-client.html#id3",
+    "title": "Garbage Collection"
+  },
+  "pxar-format": {
+    "link": "/docs/file-formats.html#pxar-format",
+    "title": "Proxmox File Archive Format (``.pxar``)"
+  },
+  "sysadmin-package-repositories": {
+    "link": "/docs/package-repositories.html#sysadmin-package-repositories",
+    "title": "Debian Package Repositories"
+  },
   "chapter-zfs": {
     "link": "/docs/sysadmin.html#chapter-zfs",
     "title": "ZFS on Linux"
   },
+  "local-zfs-special-device": {
+    "link": "/docs/sysadmin.html#local-zfs-special-device",
+    "title": "ZFS Special Device"
+  },
   "maintenance-pruning": {
     "link": "/docs/maintenance.html#maintenance-pruning",
     "title": "Pruning"
   },
+  "maintenance-gc": {
+    "link": "/docs/maintenance.html#maintenance-gc",
+    "title": "Garbage Collection"
+  },
+  "maintenance-verification": {
+    "link": "/docs/maintenance.html#maintenance-verification",
+    "title": "Verification"
+  },
   "maintenance-notification": {
     "link": "/docs/maintenance.html#maintenance-notification",
     "title": "Notifications"
@@ -27,6 +63,14 @@ const proxmoxOnlineHelpInfo = {
     "link": "/docs/managing-remotes.html#syncjobs",
     "title": "Sync Jobs"
   },
+  "sysadmin-network-configuration": {
+    "link": "/docs/network-management.html#sysadmin-network-configuration",
+    "title": "Network Management"
+  },
+  "pve-integration": {
+    "link": "/docs/pve-integration.html#pve-integration",
+    "title": "`Proxmox VE`_ Integration"
+  },
   "datastore-intro": {
     "link": "/docs/storage.html#datastore-intro",
     "title": "DataStore"
@@ -35,6 +79,10 @@ const proxmoxOnlineHelpInfo = {
     "link": "/docs/user-management.html#user-mgmt",
     "title": "User Management"
   },
+  "user-tokens": {
+    "link": "/docs/user-management.html#user-tokens",
+    "title": "API Tokens"
+  },
   "user-acl": {
     "link": "/docs/user-management.html#user-acl",
     "title": "Access Control"
-- 
2.20.1

[pve-devel] [PATCH proxmox-backup 5/5] ui: add/fix help buttons

[Aaron Lauterer]

added a few more help buttons were appropriate:

* GC and Prune schedule windows
* Create Directory window
* API Tokens, link directly to token section
* verify jobs window

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
 www/datastore/PruneAndGC.js   | 2 ++
 www/window/CreateDirectory.js | 2 ++
 www/window/TokenEdit.js       | 2 +-
 www/window/VerifyJobEdit.js   | 2 +-
 4 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/www/datastore/PruneAndGC.js b/www/datastore/PruneAndGC.js
index 91b9f0d2..ab531118 100644
--- a/www/datastore/PruneAndGC.js
+++ b/www/datastore/PruneAndGC.js
@@ -70,6 +70,7 @@ Ext.define('PBS.DataStorePruneAndGC', {
 	    editor: {
 		xtype: 'proxmoxWindowEdit',
 		title: gettext('GC Schedule'),
+		onlineHelp: 'maintenance_gc',
 		items: {
 		    xtype: 'pbsCalendarEvent',
 		    name: 'gc-schedule',
@@ -86,6 +87,7 @@ Ext.define('PBS.DataStorePruneAndGC', {
 	    editor: {
 		xtype: 'proxmoxWindowEdit',
 		title: gettext('Prune Schedule'),
+		onlineHelp: 'maintenance_pruning',
 		items: {
 		    xtype: 'pbsCalendarEvent',
 		    name: 'prune-schedule',
diff --git a/www/window/CreateDirectory.js b/www/window/CreateDirectory.js
index f68c2f78..6aabe21a 100644
--- a/www/window/CreateDirectory.js
+++ b/www/window/CreateDirectory.js
@@ -8,6 +8,8 @@ Ext.define('PBS.window.CreateDirectory', {
     url: '/nodes/localhost/disks/directory',
     method: 'POST',
 
+    onlineHelp: 'storage-disk-management',
+
     items: [
 	{
 	    xtype: 'pmxDiskSelector',
diff --git a/www/window/TokenEdit.js b/www/window/TokenEdit.js
index 6b41ae9d..caa0765c 100644
--- a/www/window/TokenEdit.js
+++ b/www/window/TokenEdit.js
@@ -3,7 +3,7 @@ Ext.define('PBS.window.TokenEdit', {
     alias: 'widget.pbsTokenEdit',
     mixins: ['Proxmox.Mixin.CBind'],
 
-    onlineHelp: 'user_mgmt',
+    onlineHelp: 'user_tokens',
 
     user: undefined,
     tokenname: undefined,
diff --git a/www/window/VerifyJobEdit.js b/www/window/VerifyJobEdit.js
index 6153c8e5..a07cf10e 100644
--- a/www/window/VerifyJobEdit.js
+++ b/www/window/VerifyJobEdit.js
@@ -5,7 +5,7 @@ Ext.define('PBS.window.VerifyJobEdit', {
 
     userid: undefined,
 
-    onlineHelp: 'verifyjobs',
+    onlineHelp: 'maintenance-verification',
 
     isAdd: true,
 
-- 
2.20.1

Re: [pve-devel] [PATCH proxmox-backup 0/5] add/fix help buttons

[Aaron Lauterer]

Sorry, sent to the wrong list!

Ignore this thread here.

On 11/10/20 11:44 AM, Aaron Lauterer wrote:
> The following series does the following:
> * adds more help buttons where appropriate
> * fixes not working help buttons
>      * by adding more references where needed
>      * changing the scanrefs script to add all references found in the
>        docs as it would not add references needed in the widget toolkit
>        in its current state. Something we will need to take another look
>        at in the future.
>      * fixing references in the docs/ui to match
> 
> In order for all the help buttons to work, the recent patch in the
> widget-toolkit which fixed the dash/underscore normalization needs to be
> applied [0].
> 
> 
> [0] https://lists.proxmox.com/pipermail/pve-devel/2020-November/045868.html
> 
> Aaron Lauterer (5):
>    scanrefs: only scan docs, not JS files
>    docs: add maintenance chapter prefix to verification ref
>    docs: add network management reference
>    ui: add all online help refs found in docs
>    ui: add/fix help buttons
> 
>   docs/_ext/proxmox-scanrefs.py | 25 ++++++++++--------
>   docs/gui.rst                  |  2 +-
>   docs/maintenance.rst          |  2 +-
>   docs/network-management.rst   |  2 ++
>   www/OnlineHelpInfo.js         | 48 +++++++++++++++++++++++++++++++++++
>   www/datastore/PruneAndGC.js   |  2 ++
>   www/window/CreateDirectory.js |  2 ++
>   www/window/TokenEdit.js       |  2 +-
>   www/window/VerifyJobEdit.js   |  2 +-
>   9 files changed, 73 insertions(+), 14 deletions(-)
>