Backup Virtual Servers - Readability improvement in the script output text

shoulders commented 2 days 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

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.
When you add a virtualmin system config this section does not have a header
Creating final backup archive section should be made clearer
When you add a virtualmin system config the summary at the end does not indicate the config has been backed up

Proposed Solutions

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

iliajie commented 2 days ago

Hello,

Thanks for your suggestions!

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!

Bold the Creating backup for virtual server example.com ..

Creating final backup archive should be bolded

Add some text to the summary at the bottom indicating the Virtualmin system config has been added.

(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 2 days 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 day 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?

I just ran backing up only the system settings and you are right, but it is not clear. It should be on a separate line and also have the word system in it.
I assumed this was somethin to do with owner accounts because you can have less of those than virtual servers

additional

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

If a server backups up successfully, Can they still have errors? perhaps you don't need to add this unless there is errors?
10 servers --> 10 Virtual servers
I added the word system to the virtualmin system configuration line so people know it is referring to the system configs and not account owner configs.
It is important to put both these on their own line because there are different and might not always be present.
I changes the order to: Virtual Servers, System
are configurations and settings not the same thing or, configurations are made up of settings? So I removed the word settings.

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 day 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 day 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.

jcameron commented 1 day 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 day ago

@jcameron I see you

have added a title for the virtualmin system config section
you have corrected the virtualmin system config section count

Thanks

Some points still to be addressed (on item 4)

If a server backups up successfully, Can they still have errors? perhaps you don't need to add this unless there is errors?
10 servers --> 10 Virtual servers
- They are not servers, they are named as virtual server througout Virtualmin so this should be consistent.
add the word system into the 8 Virtualmin configurations backed up successfully. summary line
- I added the word system to the virtualmin system configuration line so people know it is referring to the system configs and not account owner configs.
put both the success notifications on separate lines.
- It is important to put both these on their own line because they are different and might not always be present.
I set the order for the lines: Virtual Servers, System
- This reads the best
Are configurations and settings not the same thing or, configurations are made up of settings?
- I removed the word settings as I think it reads better.

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 2 hours ago

Thanks, I'll implement these suggestions!

virtualmin / virtualmin-gpl