Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add site-level announcements to OJS #9253

Closed
NateWr opened this issue Aug 23, 2023 · 26 comments
Closed

Add site-level announcements to OJS #9253

NateWr opened this issue Aug 23, 2023 · 26 comments
Assignees
@NateWr
Labels
Enhancement:1:Minor A new feature or improvement that can be implemented in less than 3 days.
Milestone
3.4.0-4

Comments

@NateWr
Copy link
Contributor

NateWr commented Aug 23, 2023 •
edited
Loading

Describe the problem you would like to solve
Multi-journal instances of OJS want to be able to add announcements at the site-level.

Describe the solution you'd like
Add announcements to the admin settings area, so that administrators can add, edit and delete announcements that appear on the site-wide homepage.

The ability to view the latest announcements will be added to the homepage in the default theme. Each site-level announcement will have its own page.

Who is asking for this feature?
This is part of sponsored development work for a PKP|PS client, UNIANDES, who will use this feature in their custom theme.

Implementation

This feature is hidden behind a config flag for 3.4.x and requires a migration to be run manually. Follow these steps to test:

  1. Check out the PRs.
  2. Add the following to the bottom of your config.inc.php file.
[features]
site_announcements = On
  1. Run the following command to run the migration.
php lib/pkp/tools/migration.php \\PKP\\migration\\upgrade\\v3_5_0\\I9253_SiteAnnouncements up
  1. Login as an admin.
  2. Go to Administration > Hosted Journals and make sure there are two or more journals.
  3. Go to Administration > Site Settings > Announcements.
  4. Click the checkbox to enable announcements and enter a positive number in the Display on Homepage field.
  5. Click the Save button.

Notes:

  • When an announcement is sent at the journal level, an email is sent to all users who have subscribed to the journal's announcements. No emails are sent for announcements at the site level because users can not subscribe or unsubscribe to these announcements.
  • This PR changes how announcements are ordered in the backend and frontend. Now they are shown with the latest first, by date_posted in descending order.
  • This PR fixes a small visual bug in the list of announcements, due to a CSS override, that caused extra padding on the page that lists announcements.
  • This only adjusts the default theme. Other themes would need to be modified separately to support this feature.
  • This PR also adds support for a featured image with each announcement.

PRs:

stable-3_4_0:
#9255
pkp/ui-library#283
pkp/ojs#4023

main:
#9260
pkp/ui-library#284
pkp/ojs#4028
@NateWr NateWr added the Enhancement:1:Minor A new feature or improvement that can be implemented in less than 3 days. label Aug 23, 2023
@NateWr NateWr self-assigned this Aug 23, 2023
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 24, 2023
@NateWr
pkp#9253 Add site-level announcements
3acc947
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 24, 2023
@NateWr
pkp#9253 Add site-level announcements
917cad1
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 24, 2023
@NateWr
pkp#9253 Hide site announcements behind feature flag
6beaf2a
@NateWr NateWr changed the title Add site-wide announcements to OJS Add site-level announcements to OJS Aug 24, 2023
NateWr added a commit to NateWr/ojs that referenced this issue Aug 24, 2023
@NateWr
pkp/pkp-lib#9253 Add site-level announcements
8a9557a
@NateWr
Copy link
Contributor Author

NateWr commented Aug 24, 2023 •
edited
Loading

The following PRs add support for announcements at the site level to the stable-3_4_0 branch. Once approved, I will port to the other apps and to the main branch. @asmecher can someone review this?

#9255
pkp/ojs#4023
pkp/ui-library#283

This feature is hidden behind a config flag for 3.4.x and requires a migration to be run manually. Follow these steps to test:

  1. Check out the PRs.
  2. Add the following to the bottom of your config.inc.php file.
[features]
site_announcements = On
  1. Run the following command to run the migration.
php lib/pkp/tools/migration.php \\PKP\\migration\\upgrade\\v3_5_0\\I9253_SiteAnnouncements up
  1. Login as an admin.
  2. Go to Administration > Hosted Journals and make sure there are two or more journals.
  3. Go to Administration > Site Settings > Announcements.
  4. Click the checkbox to enable announcements and enter a positive number in the Display on Homepage field.
  5. Click the Save button.

Notes:

  • When an announcement is sent at the journal level, an email is sent to all users who have subscribed to the journal's announcements. No emails are sent for announcements at the site level because users can not subscribe or unsubscribe to these announcements.
  • This PR changes how announcements are ordered in the backend and frontend. Now they are shown with the latest first, by date_posted in descending order.
  • This PR fixes a small visual bug in the list of announcements, due to a CSS override, that caused extra padding on the page that lists announcements.
  • This only adjusts the default theme. Other themes would need to be modified separately to support this feature.

NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 24, 2023
@NateWr
pkp#9253 Fix type error in announcement helper function
7518e9d
@asmecher
Copy link
Member

Reviews added -- thanks, @NateWr!

NateWr added a commit to NateWr/ui-library that referenced this issue Aug 25, 2023
@NateWr
pkp/pkp-lib#9253 Add site-level announcements
0be4ce5
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Use shorter syntax to filter array
9b6babb
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Use null to associate announcements with the site
e31c591
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Move shared announcements template into pkp-lib
281147d
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Add site-level announcements
56d0197
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Hide site announcements behind feature flag
ec286b1
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Fix type error in announcement helper function
54f28ae
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Use shorter syntax to filter array
9e7a6cc
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Use null to associate announcements with the site
18d9a96
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 25, 2023
@NateWr
pkp#9253 Move shared announcements template into pkp-lib
734fd7c
NateWr added a commit to NateWr/ojs that referenced this issue Aug 25, 2023
@NateWr
pkp/pkp-lib#9253 Add site-level announcements
9a17b7a
NateWr added a commit to NateWr/ojs that referenced this issue Aug 25, 2023
@NateWr
pkp/pkp-lib#9253 Move shared announcements template into pkp-lib
511c39c
@NateWr
Copy link
Contributor Author

NateWr commented Aug 25, 2023

Thanks @asmecher! I've made the change from CONTEXT_SITE_ID to null for site-level announcements and addressed your other comments. I also added a missing PR for ui-library -- just a small adjustment to show/hide stuff when announcements are enabled/disabled at the site level. There's just one unresolved comment regarding the interface for Site/Context classes.

Can you review this again when you have a moment?

@asmecher
Copy link
Member

asmecher commented Aug 25, 2023 •
edited
Loading

Looks good, @NateWr -- would you like this merged now, or would you rather do the porting to main first?
[edit: Looks like it'll need a minor amount of porting to the other apps too.]

NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 28, 2023
@NateWr
pkp#9253 Add site-level announcements
fe7138c
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 28, 2023
@NateWr
pkp#9253 Hide site announcements behind feature flag
638f4af
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 28, 2023
@NateWr
pkp#9253 Fix type error in announcement helper function
2be5ab5
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 28, 2023
@NateWr
pkp#9253 Use shorter syntax to filter array
90dba7b
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 28, 2023
@NateWr
pkp#9253 Use null to associate announcements with the site
9b5bb0a
NateWr added a commit to NateWr/pkp-lib that referenced this issue Aug 28, 2023
@NateWr
pkp#9253 Move shared announcements template into pkp-lib
ce4596d
@NateWr
Copy link
Contributor Author

NateWr commented Nov 3, 2023

@asmecher thanks, Jarda resolved that quickly yesterday. I've now got main ports for all apps and everything is passing. All PRs are ready to merge here: #9253 (comment)

asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Add site-level announcements
4835308
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Hide site announcements behind feature flag
a9715a8
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Fix type error in announcement helper function
45e1c67
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Use shorter syntax to filter array
f5e1ecf
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Use null to associate announcements with the site
b6771ef
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Move shared announcements template into pkp-lib
8a72e0f
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Fix URL in announcement API responses
17a9e6f
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Add featured image to site announcements
31d3b23
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Hide announcement images behind feature flag
b8d1f68
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Fix error when adding announcement
9fa7d30
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Fix unwanted file deletion when editing announcement
0f04c23
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Require User when handling announcement image upload
f90977a
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Fix temporary file exception name
dd4c345
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr @asmecher
#9253 Check image validity when creating announcement
f999bb8
asmecher pushed a commit to pkp/ui-library that referenced this issue Nov 8, 2023
@NateWr
pkp/pkp-lib#9253 Add site-level announcements (#283)
6f2b5cf 
* pkp/pkp-lib#9253 Add site-level announcements

* pkp/pkp-lib#9253 Use URL in announcement properties
asmecher pushed a commit to pkp/ojs that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Add site-level announcements
4178087
asmecher pushed a commit to pkp/ojs that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Move shared announcements template into pkp-lib
4aca698
asmecher pushed a commit to pkp/ui-library that referenced this issue Nov 8, 2023
@NateWr
pkp/pkp-lib#9253 Add site-level announcements (main) (#284)
d1d7930 
* pkp/pkp-lib#9253 Add site-level announcements

* pkp/pkp-lib#9253 Use URL in announcement properties

* pkp/pkp-lib#9253 Fix AnnouncementsListPanel after rebase
asmecher pushed a commit that referenced this issue Nov 8, 2023
@NateWr
#9253 Add site-level announcements (main) (#9260)
b0be24e 
* #9253 Add site-level announcements

* #9253 Fix type error in announcement helper function

* #9253 Use shorter syntax to filter array

* #9253 Use null to associate announcements with the site

* #9253 Move shared announcements template into pkp-lib

* #9253 Fix URL in announcement API responses

* #9253 Add featured image to site announcements

* #9253 Fix error when adding announcement

* #9253 Fix unwanted file deletion when editing announcement

* #9253 Add image to default announcement templates

* #9253 Make context nullable in announcements install migration

* #9253 Require User when handling announcement image upload

* Fix exception name

* Refactor to new Controllers

* #9253 Fix duplicate method name after rebase

* #9253 Fix announcements API handler after rebase

* #9253 Check image validity when creating announcement
asmecher pushed a commit to pkp/ojs that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Add site-level announcements
a65f131
asmecher pushed a commit to pkp/ojs that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Move shared announcements template into pkp-lib
3f84f4d
asmecher pushed a commit to pkp/ojs that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Run site-level announcements migration for 3.5
e0825f3
asmecher pushed a commit to pkp/ojs that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Add announcement image to default theme styles
20ba861
asmecher pushed a commit to pkp/ops that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Add site-level announcements
63cb9c9
asmecher pushed a commit to pkp/omp that referenced this issue Nov 8, 2023
@NateWr @asmecher
pkp/pkp-lib#9253 Add site-level announcements
553f073
@asmecher
Copy link
Member

asmecher commented Nov 8, 2023

All merged or cherry-picked, @NateWr! Can this be closed?

@asmecher asmecher added this to the 3.4.0-4 milestone Nov 8, 2023
@NateWr NateWr closed this as completed Nov 9, 2023
ipula pushed a commit to ipula/pkp-lib that referenced this issue Dec 4, 2023
@NateWr @ipula
pkp#9253 Add site-level announcements (main) (pkp#9260)
cda6344 
* pkp#9253 Add site-level announcements

* pkp#9253 Fix type error in announcement helper function

* pkp#9253 Use shorter syntax to filter array

* pkp#9253 Use null to associate announcements with the site

* pkp#9253 Move shared announcements template into pkp-lib

* pkp#9253 Fix URL in announcement API responses

* pkp#9253 Add featured image to site announcements

* pkp#9253 Fix error when adding announcement

* pkp#9253 Fix unwanted file deletion when editing announcement

* pkp#9253 Add image to default announcement templates

* pkp#9253 Make context nullable in announcements install migration

* pkp#9253 Require User when handling announcement image upload

* Fix exception name

* Refactor to new Controllers

* pkp#9253 Fix duplicate method name after rebase

* pkp#9253 Fix announcements API handler after rebase

* pkp#9253 Check image validity when creating announcement
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NateWr NateWr

Labels
Enhancement:1:Minor A new feature or improvement that can be implemented in less than 3 days.
Projects
None yet
Milestone
3.4.0-4
Development

No branches or pull requests
4 participants
@asmecher @defstat @NateWr @touhidurabir