From 4c3efb532d25193058d68ef91175656eab1c7255 Mon Sep 17 00:00:00 2001 From: Oguz Bektas Date: Mon, 5 Oct 2020 17:01:29 +0200 Subject: [PATCH] gui: add onlineHelp for 'Prune Options' also renamed the 'pruning' ref to 'backup-pruning' for clarity. Signed-off-by: Oguz Bektas --- docs/backup-client.rst | 2 +- docs/storage.rst | 4 ++-- www/OnlineHelpInfo.js | 38 ++++++++++++++++++------------------- www/window/DataStoreEdit.js | 10 +++++++--- 4 files changed, 29 insertions(+), 25 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index afa56fd8..eac7a353 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -533,7 +533,7 @@ To remove the ticket, issue a logout: # proxmox-backup-client logout -.. _pruning: +.. _backup-pruning: Pruning and Removing Backups ---------------------------- diff --git a/docs/storage.rst b/docs/storage.rst index 3a4875c6..3eb505a7 100644 --- a/docs/storage.rst +++ b/docs/storage.rst @@ -116,7 +116,7 @@ configured. The datastore is identified by a simple *name* and points to a directory on the filesystem. Each datastore also has associated retention settings of how many backup snapshots for each interval of ``hourly``, ``daily``, ``weekly``, ``monthly``, ``yearly`` as well as a time-independent -number of backups to keep in that store. :ref:`Pruning ` and +number of backups to keep in that store. :ref:`backup-pruning` and :ref:`garbage collection ` can also be configured to run periodically based on a configured schedule (see :ref:`calendar-events`) per datastore. @@ -136,7 +136,7 @@ the menu tree and clicking **Create**. Here: * *GC Schedule* refers to the time and intervals at which garbage collection runs * *Prune Schedule* refers to the frequency at which pruning takes place -* *Prune Options* set the amount of backups which you would like to keep (see :ref:`Pruning `). +* *Prune Options* set the amount of backups which you would like to keep (see :ref:`backup-pruning`). Alternatively you can create a new datastore from the command line. The following command creates a new datastore called ``store1`` on :file:`/backup/disk1/store1` diff --git a/www/OnlineHelpInfo.js b/www/OnlineHelpInfo.js index ff56553e..235c5831 100644 --- a/www/OnlineHelpInfo.js +++ b/www/OnlineHelpInfo.js @@ -3,28 +3,28 @@ const proxmoxOnlineHelpInfo = { "link": "/docs/index.html", "title": "Proxmox Backup Server Documentation Index" }, - "datastore-intro": { - "link": "/docs/administration-guide.html#datastore-intro", - "title": ":term:`DataStore`" - }, - "user-mgmt": { - "link": "/docs/administration-guide.html#user-mgmt", - "title": "User Management" - }, - "user-acl": { - "link": "/docs/administration-guide.html#user-acl", - "title": "Access Control" - }, - "backup-remote": { - "link": "/docs/administration-guide.html#backup-remote", - "title": ":term:`Remote`" - }, - "syncjobs": { - "link": "/docs/administration-guide.html#syncjobs", - "title": "Sync Jobs" + "backup-pruning": { + "link": "/docs/backup-client.html#backup-pruning", + "title": "Pruning and Removing Backups" }, "chapter-zfs": { "link": "/docs/sysadmin.html#chapter-zfs", "title": "ZFS on Linux" + }, + "syncjobs": { + "link": "/docs/managing-remotes.html#syncjobs", + "title": "Sync Jobs" + }, + "datastore-intro": { + "link": "/docs/storage.html#datastore-intro", + "title": ":term:`DataStore`" + }, + "user-mgmt": { + "link": "/docs/user-management.html#user-mgmt", + "title": "User Management" + }, + "user-acl": { + "link": "/docs/user-management.html#user-acl", + "title": "Access Control" } }; diff --git a/www/window/DataStoreEdit.js b/www/window/DataStoreEdit.js index f565cee5..c2a9527a 100644 --- a/www/window/DataStoreEdit.js +++ b/www/window/DataStoreEdit.js @@ -3,9 +3,6 @@ Ext.define('PBS.DataStoreEdit', { alias: 'widget.pbsDataStoreEdit', mixins: ['Proxmox.Mixin.CBind'], - - onlineHelp: 'datastore_intro', - subject: gettext('Datastore'), isAdd: true, @@ -30,10 +27,16 @@ Ext.define('PBS.DataStoreEdit', { items: { xtype: 'tabpanel', bodyPadding: 10, + listeners: { + tabchange: function(tb, newCard) { + Ext.GlobalEvents.fireEvent('proxmoxShowHelp', newCard.onlineHelp); + } + }, items: [ { title: gettext('General'), xtype: 'inputpanel', + onlineHelp: 'datastore_intro', column1: [ { xtype: 'pmxDisplayEditField', @@ -95,6 +98,7 @@ Ext.define('PBS.DataStoreEdit', { { title: gettext('Prune Options'), xtype: 'inputpanel', + onlineHelp: 'backup_pruning', column1: [ { xtype: 'proxmoxintegerfield',