virtualmin / virtualmin-gpl

Virtualmin web hosting control panel for Webmin
https://www.virtualmin.com
GNU General Public License v3.0
330 stars 102 forks source link

Backup Virtual Servers - Readability improvement in the script output text #918

Open shoulders opened 1 month ago

shoulders commented 1 month ago
SYSTEM INFORMATION
OS type and version Ubuntu Linux 22.04.5
Usermin version 2.102
Virtualmin version 7.20.2 Pro
Theme version 21.20.7
Apache version 2.4.52
Package updates 2 package updates are available

Background

When you backup virtual servers you get an output on screen telling you what is going on.

The issue

  1. Although the backup all works I feel that the output text could be a little clearer so the end users can see what is going on easier, in particular the separation between the virtual servers.
  2. When you add a virtualmin system config this section does not have a header
  3. Creating final backup archive section should be made clearer
  4. When you add a virtualmin system config the summary at the end does not indicate the config has been backed up

image

Proposed Solutions

  1. Bold the Creating backup for virtual server example.com ..
  2. Add a heading to the Virtualmin system config section in bold.
  3. Creating final backup archive should be bolded
  4. Add some text to the summary at the bottom indicating the Virtualmin system config has been added.
  5. (optional) further separate the summary section with a bolded header

image

iliajie commented 1 month ago

Hello,

Thanks for your suggestions!

  1. Add a heading to the Virtualmin system config section in bold.

Thanks for pointing this out!

Yes, this is a bug and should be fixed! We need to wait for Jamie's comment on this though!

  1. Bold the Creating backup for virtual server example.com ..
  2. Creating final backup archive should be bolded
  3. Add some text to the summary at the bottom indicating the Virtualmin system config has been added.
  4. (optional) further separate the summary section with a bolded header

Well, this isn't something common for Virtualmin, and I personally don't like how it looks.

jcameron commented 1 month ago

Thanks, I've checked in a fix for that missing heading.

As for the other suggestions, I don't really like bolding as it would be inconsistent with the rest of Virtualmin.

Also, doesn't the summary already say that Virtualmin settings were backed up?

shoulders commented 1 month ago

Thanks, I've checked in a fix for that missing heading.

Brilliant + thanks

As for the other suggestions, I don't really like bolding as it would be inconsistent with the rest of Virtualmin.

Fair enough

Also, doesn't the summary already say that Virtualmin settings were backed up?

image

additional

Personally I think the summary line that is there is not very clear.

I think it would be better if it reads like:

10 Virtual servers backed up successfully. 8 Virtualmin system configurations backed up successfully.

iliajie commented 1 month ago

I think it would be better if it reads like:

10 Virtual servers backed up successfully. 8 Virtualmin system configurations backed up successfully.

Jamie, why were 10 virtual servers backed up successfully, but only 8 Virtualmin configuration settings?

shoulders commented 1 month ago

Jamie, why were 10 virtual servers backed up successfully, but only 8 Virtualmin configuration settings?

Exactly why I was confused. the 8 Virtualmin configuration settings refer to the 8 areas of virtualmin system configs that are backed up. However there are more than 8.

image

jcameron commented 1 month ago

. Exactly why I was confused. the 8 Virtualmin configuration settings refer to the 8 areas of virtualmin system configs that are backed up. However there are more than 8.

Ok that's a bug which I've just checked in a fix for

shoulders commented 1 month ago

@jcameron I see you

Thanks

Some points still to be addressed (on item 4)

This will give the following example and I think it reads better and more logical with these small changes:

10 Virtual servers backed up successfully. 8 Virtualmin system configurations backed up successfully.

jcameron commented 1 month ago

Thanks, I'll implement these suggestions!