all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Oguz Bektas <o.bektas@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup] gui: add onlineHelp for 'Prune Options'
Date: Mon,  5 Oct 2020 17:01:29 +0200	[thread overview]
Message-ID: <20201005150129.2206440-1-o.bektas@proxmox.com> (raw)

also renamed the 'pruning' ref to 'backup-pruning' for clarity.

Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
---
 docs/backup-client.rst      |  2 +-
 docs/storage.rst            |  4 ++--
 www/OnlineHelpInfo.js       | 30 +++++++++++++++---------------
 www/window/DataStoreEdit.js | 10 +++++++---
 4 files changed, 25 insertions(+), 21 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 <pruning>` and
+number of backups to keep in that store. :ref:`backup-pruning` and
 :ref:`garbage collection <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 <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"
   },
+  "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/administration-guide.html#datastore-intro",
+    "link": "/docs/storage.html#datastore-intro",
     "title": ":term:`DataStore`"
   },
   "user-mgmt": {
-    "link": "/docs/administration-guide.html#user-mgmt",
+    "link": "/docs/user-management.html#user-mgmt",
     "title": "User Management"
   },
   "user-acl": {
-    "link": "/docs/administration-guide.html#user-acl",
+    "link": "/docs/user-management.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"
-  },
-  "chapter-zfs": {
-    "link": "/docs/sysadmin.html#chapter-zfs",
-    "title": "ZFS on Linux"
   }
 };
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',
-- 
2.20.1




             reply	other threads:[~2020-10-05 15:01 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-05 15:01 Oguz Bektas [this message]
2020-10-05 15:39 ` [pbs-devel] applied: " 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=20201005150129.2206440-1-o.bektas@proxmox.com \
    --to=o.bektas@proxmox.com \
    --cc=pbs-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal