[pve-devel] [RFC manager] ui: DirEdit: add hint when to enable shared

[pve-devel] [RFC manager] ui: DirEdit: add hint when to enable shared

[Aaron Lauterer]

To hopefully reduce confusion what the 'shared' checkbox does.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---

I saw it one time too many where users were a bit confused as to what
this checkbox is for. Since we have a hard time to find a better label,
maybe we want to put a small hint below it?

The phrasing can probably be improved upon. But I think having something
there that can hopefully explain it enough, transporting that the
sharing itself needs to be configured beforehand by the user, would help.

 www/manager6/storage/DirEdit.js | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/www/manager6/storage/DirEdit.js b/www/manager6/storage/DirEdit.js
index 7e9ec44d..8c6f868a 100644
--- a/www/manager6/storage/DirEdit.js
+++ b/www/manager6/storage/DirEdit.js
@@ -31,6 +31,10 @@ Ext.define('PVE.storage.DirInputPanel', {
 		uncheckedValue: 0,
 		fieldLabel: gettext('Shared'),
 	    },
+	    {
+		xtype: 'displayfield',
+		value: gettext('Enable if the path is a location that is shared between the nodes in the cluster.'),
+	    },
 	];
 
 	me.callParent();
-- 
2.30.2

Re: [pve-devel] [RFC manager] ui: DirEdit: add hint when to enable shared

[Lukas Wagner]

Hi!

On 5/9/23 09:56, Aaron Lauterer wrote:
> To hopefully reduce confusion what the 'shared' checkbox does.
> 
> Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
> ---
> 
> I saw it one time too many where users were a bit confused as to what
> this checkbox is for. Since we have a hard time to find a better label,
> maybe we want to put a small hint below it?
> 
> The phrasing can probably be improved upon. But I think having something
> there that can hopefully explain it enough, transporting that the
> sharing itself needs to be configured beforehand by the user, would help.
> 
>   www/manager6/storage/DirEdit.js | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/www/manager6/storage/DirEdit.js b/www/manager6/storage/DirEdit.js
> index 7e9ec44d..8c6f868a 100644
> --- a/www/manager6/storage/DirEdit.js
> +++ b/www/manager6/storage/DirEdit.js
> @@ -31,6 +31,10 @@ Ext.define('PVE.storage.DirInputPanel', {
>   		uncheckedValue: 0,
>   		fieldLabel: gettext('Shared'),
>   	    },
> +	    {
> +		xtype: 'displayfield',
> +		value: gettext('Enable if the path is a location that is shared between the nodes in the cluster.'),
> +	    },
>   	];
>   
>   	me.callParent();

The wording is fine, but I think a tooltip instead of a displayfield would be better.
Also, don't forget that the 'shared' flag also exists for LVM storage.

As a side note, the documentation does not really explain the flag at all. I think
one short paragraph on the effects of this flag and when/how to use it would not hurt.

Cheers,
-- 
- Lukas

Re: [pve-devel] [RFC manager] ui: DirEdit: add hint when to enable shared

[Fiona Ebner]

Am 09.05.23 um 09:56 schrieb Aaron Lauterer:
> To hopefully reduce confusion what the 'shared' checkbox does.
> 
> Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
> ---
> 
> I saw it one time too many where users were a bit confused as to what
> this checkbox is for. Since we have a hard time to find a better label,
> maybe we want to put a small hint below it?
> 
> The phrasing can probably be improved upon. But I think having something
> there that can hopefully explain it enough, transporting that the
> sharing itself needs to be configured beforehand by the user, would help.
> 
>  www/manager6/storage/DirEdit.js | 4 ++++

While directory certainly is the most common one, adding a similar hint
for LVM might also be worth it.

>  1 file changed, 4 insertions(+)
> 
> diff --git a/www/manager6/storage/DirEdit.js b/www/manager6/storage/DirEdit.js
> index 7e9ec44d..8c6f868a 100644
> --- a/www/manager6/storage/DirEdit.js
> +++ b/www/manager6/storage/DirEdit.js
> @@ -31,6 +31,10 @@ Ext.define('PVE.storage.DirInputPanel', {
>  		uncheckedValue: 0,
>  		fieldLabel: gettext('Shared'),
>  	    },
> +	    {
> +		xtype: 'displayfield',

Might be better as a tooltip or do you think that's not prominent enough?

> +		value: gettext('Enable if the path is a location that is shared between the nodes in the cluster.'),

With regards to phrasing: maybe "Enable if the underlying file system is
already shared between nodes"?

> +	    },
>  	];
>  
>  	me.callParent();

Re: [pve-devel] [RFC manager] ui: DirEdit: add hint when to enable shared

[Aaron Lauterer]

I'll send a v2 with tooltips and for LVM as well.

On 8/21/23 10:48, Fiona Ebner wrote:
> Am 09.05.23 um 09:56 schrieb Aaron Lauterer:
>> To hopefully reduce confusion what the 'shared' checkbox does.
>>
>> Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
>> ---
>>
>> I saw it one time too many where users were a bit confused as to what
>> this checkbox is for. Since we have a hard time to find a better label,
>> maybe we want to put a small hint below it?
>>
>> The phrasing can probably be improved upon. But I think having something
>> there that can hopefully explain it enough, transporting that the
>> sharing itself needs to be configured beforehand by the user, would help.
>>
>>   www/manager6/storage/DirEdit.js | 4 ++++
> 
> While directory certainly is the most common one, adding a similar hint
> for LVM might also be worth it.

Good idea!

> 
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/www/manager6/storage/DirEdit.js b/www/manager6/storage/DirEdit.js
>> index 7e9ec44d..8c6f868a 100644
>> --- a/www/manager6/storage/DirEdit.js
>> +++ b/www/manager6/storage/DirEdit.js
>> @@ -31,6 +31,10 @@ Ext.define('PVE.storage.DirInputPanel', {
>>   		uncheckedValue: 0,
>>   		fieldLabel: gettext('Shared'),
>>   	    },
>> +	    {
>> +		xtype: 'displayfield',
> 
> Might be better as a tooltip or do you think that's not prominent enough?

Both work for me. From a UI perspective, the tooltip is surely better. The 
downside is, that users might not notice it.

> 
>> +		value: gettext('Enable if the path is a location that is shared between the nodes in the cluster.'),
> 
> With regards to phrasing: maybe "Enable if the underlying file system is
> already shared between nodes"?
> 
Sounds better than the first iteration.
>> +	    },
>>   	];
>>   
>>   	me.callParent();