* [pbs-devel] [PATCH proxmox-backup] docs: add onlineHelp to some panels
@ 2020-09-21 11:25 Oguz Bektas
2020-09-22 13:33 ` Dominik Csapak
2020-09-22 17:49 ` [pbs-devel] applied: " Thomas Lamprecht
0 siblings, 2 replies; 3+ messages in thread
From: Oguz Bektas @ 2020-09-21 11:25 UTC (permalink / raw)
To: pbs-devel
name sections according to the title or content and add
the respective onlineHelp to the following panels:
- datastore
- user management
- ACL
- backup remote
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
---
docs/administration-guide.rst | 8 ++++++--
www/OnlineHelpInfo.js | 16 ++++++++++++++++
www/window/ACLEdit.js | 2 ++
www/window/DataStoreEdit.js | 3 +++
www/window/RemoteEdit.js | 2 ++
www/window/UserEdit.js | 2 ++
6 files changed, 31 insertions(+), 2 deletions(-)
diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index fed9bbe9..f7cd6ddf 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -127,7 +127,7 @@ Backup Server Management
The command line tool to configure and manage the backup server is called
:command:`proxmox-backup-manager`.
-
+.. _datastore_intro:
:term:`DataStore`
~~~~~~~~~~~~~~~~~
@@ -364,7 +364,7 @@ directories will store the chunked data after a backup operation has been execut
276489 drwxr-xr-x 3 backup backup 4.0K Jul 8 12:35 ..
276490 drwxr-x--- 1 backup backup 1.1M Jul 8 12:35 .
-
+.. _user_mgmt:
User Management
~~~~~~~~~~~~~~~
@@ -448,6 +448,8 @@ Or completely remove the user with:
# proxmox-backup-manager user remove john@pbs
+.. _user_acl:
+
Access Control
~~~~~~~~~~~~~~
@@ -631,6 +633,8 @@ You can also configure DNS settings, from the **DNS** section
of **Configuration** or by using the ``dns`` subcommand of
``proxmox-backup-manager``.
+.. _backup_remote:
+
:term:`Remote`
~~~~~~~~~~~~~~
diff --git a/www/OnlineHelpInfo.js b/www/OnlineHelpInfo.js
index 0b81b218..ff56553e 100644
--- a/www/OnlineHelpInfo.js
+++ b/www/OnlineHelpInfo.js
@@ -3,6 +3,22 @@ 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"
diff --git a/www/window/ACLEdit.js b/www/window/ACLEdit.js
index 17879a3c..e33f1f36 100644
--- a/www/window/ACLEdit.js
+++ b/www/window/ACLEdit.js
@@ -3,6 +3,8 @@ Ext.define('PBS.window.ACLEdit', {
alias: 'widget.pbsACLAdd',
mixins: ['Proxmox.Mixin.CBind'],
+ onlineHelp: 'user_acl',
+
url: '/access/acl',
method: 'PUT',
isAdd: true,
diff --git a/www/window/DataStoreEdit.js b/www/window/DataStoreEdit.js
index 926a8a19..f565cee5 100644
--- a/www/window/DataStoreEdit.js
+++ b/www/window/DataStoreEdit.js
@@ -3,6 +3,9 @@ Ext.define('PBS.DataStoreEdit', {
alias: 'widget.pbsDataStoreEdit',
mixins: ['Proxmox.Mixin.CBind'],
+
+ onlineHelp: 'datastore_intro',
+
subject: gettext('Datastore'),
isAdd: true,
diff --git a/www/window/RemoteEdit.js b/www/window/RemoteEdit.js
index ea4dc538..b7645af8 100644
--- a/www/window/RemoteEdit.js
+++ b/www/window/RemoteEdit.js
@@ -3,6 +3,8 @@ Ext.define('PBS.window.RemoteEdit', {
alias: 'widget.pbsRemoteEdit',
mixins: ['Proxmox.Mixin.CBind'],
+ onlineHelp: 'backup_remote',
+
userid: undefined,
isAdd: true,
diff --git a/www/window/UserEdit.js b/www/window/UserEdit.js
index d1da9f4b..d39a85d2 100644
--- a/www/window/UserEdit.js
+++ b/www/window/UserEdit.js
@@ -3,6 +3,8 @@ Ext.define('PBS.window.UserEdit', {
alias: 'widget.pbsUserEdit',
mixins: ['Proxmox.Mixin.CBind'],
+ onlineHelp: 'user_mgmt',
+
userid: undefined,
isAdd: true,
--
2.20.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [pbs-devel] [PATCH proxmox-backup] docs: add onlineHelp to some panels
2020-09-21 11:25 [pbs-devel] [PATCH proxmox-backup] docs: add onlineHelp to some panels Oguz Bektas
@ 2020-09-22 13:33 ` Dominik Csapak
2020-09-22 17:49 ` [pbs-devel] applied: " Thomas Lamprecht
1 sibling, 0 replies; 3+ messages in thread
From: Dominik Csapak @ 2020-09-22 13:33 UTC (permalink / raw)
To: pbs-devel
LGTM
Reviewed-By: Dominik Csapak <d.csapak@proxmox.com>
Tested-By: Dominik Csapak <d.csapak@proxmox.com>
On 9/21/20 1:25 PM, Oguz Bektas wrote:
> name sections according to the title or content and add
> the respective onlineHelp to the following panels:
> - datastore
> - user management
> - ACL
> - backup remote
>
> Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
> ---
> docs/administration-guide.rst | 8 ++++++--
> www/OnlineHelpInfo.js | 16 ++++++++++++++++
> www/window/ACLEdit.js | 2 ++
> www/window/DataStoreEdit.js | 3 +++
> www/window/RemoteEdit.js | 2 ++
> www/window/UserEdit.js | 2 ++
> 6 files changed, 31 insertions(+), 2 deletions(-)
>
> diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
> index fed9bbe9..f7cd6ddf 100644
> --- a/docs/administration-guide.rst
> +++ b/docs/administration-guide.rst
> @@ -127,7 +127,7 @@ Backup Server Management
> The command line tool to configure and manage the backup server is called
> :command:`proxmox-backup-manager`.
>
> -
> +.. _datastore_intro:
>
> :term:`DataStore`
> ~~~~~~~~~~~~~~~~~
> @@ -364,7 +364,7 @@ directories will store the chunked data after a backup operation has been execut
> 276489 drwxr-xr-x 3 backup backup 4.0K Jul 8 12:35 ..
> 276490 drwxr-x--- 1 backup backup 1.1M Jul 8 12:35 .
>
> -
> +.. _user_mgmt:
>
> User Management
> ~~~~~~~~~~~~~~~
> @@ -448,6 +448,8 @@ Or completely remove the user with:
> # proxmox-backup-manager user remove john@pbs
>
>
> +.. _user_acl:
> +
> Access Control
> ~~~~~~~~~~~~~~
>
> @@ -631,6 +633,8 @@ You can also configure DNS settings, from the **DNS** section
> of **Configuration** or by using the ``dns`` subcommand of
> ``proxmox-backup-manager``.
>
> +.. _backup_remote:
> +
> :term:`Remote`
> ~~~~~~~~~~~~~~
>
> diff --git a/www/OnlineHelpInfo.js b/www/OnlineHelpInfo.js
> index 0b81b218..ff56553e 100644
> --- a/www/OnlineHelpInfo.js
> +++ b/www/OnlineHelpInfo.js
> @@ -3,6 +3,22 @@ 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"
> diff --git a/www/window/ACLEdit.js b/www/window/ACLEdit.js
> index 17879a3c..e33f1f36 100644
> --- a/www/window/ACLEdit.js
> +++ b/www/window/ACLEdit.js
> @@ -3,6 +3,8 @@ Ext.define('PBS.window.ACLEdit', {
> alias: 'widget.pbsACLAdd',
> mixins: ['Proxmox.Mixin.CBind'],
>
> + onlineHelp: 'user_acl',
> +
> url: '/access/acl',
> method: 'PUT',
> isAdd: true,
> diff --git a/www/window/DataStoreEdit.js b/www/window/DataStoreEdit.js
> index 926a8a19..f565cee5 100644
> --- a/www/window/DataStoreEdit.js
> +++ b/www/window/DataStoreEdit.js
> @@ -3,6 +3,9 @@ Ext.define('PBS.DataStoreEdit', {
> alias: 'widget.pbsDataStoreEdit',
> mixins: ['Proxmox.Mixin.CBind'],
>
> +
> + onlineHelp: 'datastore_intro',
> +
> subject: gettext('Datastore'),
> isAdd: true,
>
> diff --git a/www/window/RemoteEdit.js b/www/window/RemoteEdit.js
> index ea4dc538..b7645af8 100644
> --- a/www/window/RemoteEdit.js
> +++ b/www/window/RemoteEdit.js
> @@ -3,6 +3,8 @@ Ext.define('PBS.window.RemoteEdit', {
> alias: 'widget.pbsRemoteEdit',
> mixins: ['Proxmox.Mixin.CBind'],
>
> + onlineHelp: 'backup_remote',
> +
> userid: undefined,
>
> isAdd: true,
> diff --git a/www/window/UserEdit.js b/www/window/UserEdit.js
> index d1da9f4b..d39a85d2 100644
> --- a/www/window/UserEdit.js
> +++ b/www/window/UserEdit.js
> @@ -3,6 +3,8 @@ Ext.define('PBS.window.UserEdit', {
> alias: 'widget.pbsUserEdit',
> mixins: ['Proxmox.Mixin.CBind'],
>
> + onlineHelp: 'user_mgmt',
> +
> userid: undefined,
>
> isAdd: true,
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* [pbs-devel] applied: [PATCH proxmox-backup] docs: add onlineHelp to some panels
2020-09-21 11:25 [pbs-devel] [PATCH proxmox-backup] docs: add onlineHelp to some panels Oguz Bektas
2020-09-22 13:33 ` Dominik Csapak
@ 2020-09-22 17:49 ` Thomas Lamprecht
1 sibling, 0 replies; 3+ messages in thread
From: Thomas Lamprecht @ 2020-09-22 17:49 UTC (permalink / raw)
To: Proxmox Backup Server development discussion, Oguz Bektas,
Dominik Csapak
On 21.09.20 13:25, Oguz Bektas wrote:
> name sections according to the title or content and add
> the respective onlineHelp to the following panels:
> - datastore
> - user management
> - ACL
> - backup remote
>
> Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
> ---
> docs/administration-guide.rst | 8 ++++++--
> www/OnlineHelpInfo.js | 16 ++++++++++++++++
> www/window/ACLEdit.js | 2 ++
> www/window/DataStoreEdit.js | 3 +++
> www/window/RemoteEdit.js | 2 ++
> www/window/UserEdit.js | 2 ++
> 6 files changed, 31 insertions(+), 2 deletions(-)
>
>
applied, with Dominik's R-b and T-b, thanks to both!
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-09-22 17:49 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-21 11:25 [pbs-devel] [PATCH proxmox-backup] docs: add onlineHelp to some panels Oguz Bektas
2020-09-22 13:33 ` Dominik Csapak
2020-09-22 17:49 ` [pbs-devel] applied: " Thomas Lamprecht
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