From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <d.csapak@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 33BEA636A5
for <pbs-devel@lists.proxmox.com>; Tue, 22 Sep 2020 15:33:50 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 2025F2EC77
for <pbs-devel@lists.proxmox.com>; Tue, 22 Sep 2020 15:33:20 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[212.186.127.180])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256)
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS id 4F7382EC69
for <pbs-devel@lists.proxmox.com>; Tue, 22 Sep 2020 15:33:19 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 1D97C4549A
for <pbs-devel@lists.proxmox.com>; Tue, 22 Sep 2020 15:33:19 +0200 (CEST)
To: pbs-devel@lists.proxmox.com
References: <20200921112549.469308-1-o.bektas@proxmox.com>
From: Dominik Csapak <d.csapak@proxmox.com>
Message-ID: <8fa77bbb-f39e-d4a9-b099-071822ba5d1e@proxmox.com>
Date: Tue, 22 Sep 2020 15:33:18 +0200
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:81.0) Gecko/20100101
Thunderbird/81.0
MIME-Version: 1.0
In-Reply-To: <20200921112549.469308-1-o.bektas@proxmox.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.515 Adjusted score from AWL reputation of From: address
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
NICE_REPLY_A -0.001 Looks like a legit reply (A)
RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/,
medium trust
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
Subject: Re: [pbs-devel] [PATCH proxmox-backup] docs: add onlineHelp to some
panels
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 22 Sep 2020 13:33:50 -0000
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,
>