Bug 38448 - Fix inconsistencies in database update messages
Summary: Fix inconsistencies in database update messages
Status: Pushed to main
Alias: None
Product: Koha
Classification: Unclassified
Component: Installation and upgrade (command-line installer) (show other bugs)
Version: Main
Hardware: All All
: P5 - low minor
Assignee: David Nind
QA Contact: Marcel de Rooy
URL:
Keywords:
Depends on: 38394
Blocks:
  Show dependency treegraph
 
Reported: 2024-11-14 15:19 UTC by Katrin Fischer
Modified: 2025-01-10 18:21 UTC (History)
5 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Trivial patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
This fixes some database update messages to improve their consistency with the database update guidelines.
Version(s) released in:
25.05.00
Circulation function:


Attachments
Bug 38448: Fix inconsistencies in database update messages (5.78 KB, patch)
2024-12-16 20:31 UTC, David Nind
Details | Diff | Splinter Review
Bug 38448: Fix inconsistencies in database update messages (5.84 KB, patch)
2025-01-06 19:55 UTC, Leo Stoyanov
Details | Diff | Splinter Review
Bug 38448: Fix inconsistencies in database update messages (5.94 KB, patch)
2025-01-10 10:01 UTC, Marcel de Rooy
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Katrin Fischer 2024-11-14 15:19:39 UTC
Moved from bug 38394:

* "Added OAI-PMH:HarvestEmailReport system preference" should be "Added new system preference 'OAI-PMH:HarvestEmailReport'"

* Added new system preference 'JobsNotificationMethod' is white instead of green

* Added column 'service_platformerm_usage_data_providers' is blue (why not green?)

* "list_borrowers added to 1 users with manage_bookings" should be better worded, like "Added permissions 'permission' to ..."

* "Added BOOKING_CANCELLATION authorised value category" should be "Added new authorised value category 'CAT'"

* "Updated manage_search_targets permission description" => this is only noise
Comment 1 David Nind 2024-12-02 21:34:22 UTC
I'm happy to have a go at this, if it is just a matter of updating the individual db_revs.
Comment 2 Katrin Fischer 2024-12-03 08:06:03 UTC
(In reply to David Nind from comment #1)
> I'm happy to have a go at this, if it is just a matter of updating the
> individual db_revs.

Hi David, yes, the mission would be to make the output messages more standardized.
Comment 3 David Nind 2024-12-16 20:31:59 UTC
Created attachment 175580 [details] [review]
Bug 38448: Fix inconsistencies in database update messages

This fixes some database update messages to improve their
consistency with the database update guidelines
https://wiki.koha-community.org/wiki/Database_updates

Test plan:
1. Apply the patch.
2. Review the differences to make sure the messages make
   sense and are consistent with the database update
   guidelines:
   2.1 Review the diff attached to the bug
   or
   2.2 Run: git show
3. Sign off D:

Signed-off-by: David Nind <david@davidnind.com>
Comment 4 David Nind 2024-12-16 20:33:59 UTC
Here is a list of the changes and the reason:

1. Consistency with other messages and improve wording:
   From: "list_borrowers added to $count users with XXX"
   To: "Added permission 'list_borrowers' to $count users with 'XXX' permissions"
2. Changed the type of message from info (blue) to success (green):
   From:  say_info( $out, "Added column 'service_platformerm_usage_data_providers'" );
   To:    say_success( $out, "Added column 'service_platformerm_usage_data_providers'" );
3. Changed the type of message from plain (white) to success (green):
   From:  say $out "Added new system preference 'JobsNotificationMethod'";
   To:    say_success( $out, "Added new system preference 'JobsNotificationMethod'" );
4. Consistency with other messages:
   From: "Added BOOKING_CANCELLATION authorised value category"
   To: "Added new authorized value category 'BOOKING_CANCELLATION'"
5. Removed 'noisy' message that is not required:
   say_success( $out, "Updated manage_search_targets permission description" );
6. Consistency with other messages:
   From: "Added OAI-PMH:HarvestEmailReport system preference
   To:   "Added new system preference 'OAI-PMH:HarvestEmailReport'"
Comment 5 Leo Stoyanov 2025-01-06 19:55:26 UTC
Created attachment 176165 [details] [review]
Bug 38448: Fix inconsistencies in database update messages

This fixes some database update messages to improve their
consistency with the database update guidelines
https://wiki.koha-community.org/wiki/Database_updates

Test plan:
1. Apply the patch.
2. Review the differences to make sure the messages make
   sense and are consistent with the database update
   guidelines:
   2.1 Review the diff attached to the bug
   or
   2.2 Run: git show
3. Sign off D:

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Leo Stoyanov <leo.stoyanov@bywatersolutions.com>
Comment 6 David Nind 2025-01-08 10:19:33 UTC
Thanks Leo for the sign off!
Comment 7 Marcel de Rooy 2025-01-10 10:01:47 UTC
Created attachment 176317 [details] [review]
Bug 38448: Fix inconsistencies in database update messages

This fixes some database update messages to improve their
consistency with the database update guidelines
https://wiki.koha-community.org/wiki/Database_updates

Test plan:
1. Apply the patch.
2. Review the differences to make sure the messages make
   sense and are consistent with the database update
   guidelines:
   2.1 Review the diff attached to the bug
   or
   2.2 Run: git show
3. Sign off D:

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Leo Stoyanov <leo.stoyanov@bywatersolutions.com>

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Comment 8 Katrin Fischer 2025-01-10 18:21:01 UTC
Pushed for 25.05!

Well done everyone, thank you!