Admin announcement feature #7067

ahmadhamzh · 2025-01-08T12:36:16Z

What this PR does / why we need it:
Add a new feature to the admin page, allowing admins to broadcast announcements to users. Users will see the most recent announcement displayed as a banner across all pages and can view a list of all announcements by opening the announcement dialog from the help panel menu.

Admin- Announcement Page:

**add/edit announcement dialog: **

Announcement banner:

list of announcements dialog:

Which issue(s) this PR fixes:

Fixes #6645

What type of PR is this?
/kind feature

Does this PR introduce a user-facing change? Then add your Release Note here:

Added a new admin announcement feature. Admins can broadcast messages to users, displayed as banners on all pages, with a full list accessible through the help panel.

Documentation:

TBD

ahmadhamzh · 2025-01-09T13:30:12Z

/retest

csengerszabo · 2025-01-10T08:15:17Z

Expires date and Expires time should be Expire date and Expire time

+Add in the button of the add/edit announcement dialog should be Save

Otherwise, looking good!

ahmadhamzh · 2025-01-10T08:28:13Z

+Add in the button of the add/edit announcement dialog should be Save

@csengerszabo
I use "Add" for new announcements, but when the dialog is for editing, it changes to "Save."
The picture above shows adding a new announcement after filling in the fields.

ahmadhamzh · 2025-01-10T19:56:02Z

/retest

Waseem826

I've left some feedback after reviewing the UI part. PTAL

Waseem826 · 2025-01-13T07:53:54Z

modules/web/package-lock.json

Please revert changes in this file. If this needs to be updated then it should be done in separate PR.

Waseem826 · 2025-01-13T08:58:06Z

modules/web/src/app/core/components/help-panel/component.ts

+        if (data) {
+          const adminAnnouncementsID = Object.keys(announcementsObject);
+          const readAnnouncements = data.filter(
+            (value, index, self) => self.indexOf(value) === index && adminAnnouncementsID.includes(value)


Just curious why do we need self.indexOf(value) === index? Isn't this always true? Also noticed this in announcement-banner component.

Waseem826 · 2025-01-13T15:18:08Z

modules/web/src/app/core/components/help-panel/template.html

           class="km-option-hover-bg"
           id="km-navbar-api-docs-btn"
           matRipple
           (click)="goToAPIDocs()">
        API Documentation
      </div>

-      <div *ngFor="let link of settings?.customLinks | kmLinkLocation: 'HelpPanel'"
+      <div *ngIf="adminSettings?.displayAPIDocs"


This check should be removed.

Suggested change

<div *ngIf="adminSettings?.displayAPIDocs"

<div *ngIf="adminSettings?.displayAPIDocs"

Waseem826 · 2025-01-13T15:18:23Z

modules/web/src/app/core/components/help-panel/template.html

+           class="km-option-hover-bg"
+           matRipple
+           (click)="openAnnouncementsDialog()">
+        Announcement


Nit pick

Suggested change

Announcement

Announcements

Waseem826 · 2025-01-13T21:02:40Z

modules/web/src/app/settings/admin/announcement/announcement-dialog/component.ts

@@ -0,0 +1,163 @@
+// Copyright 2024 The Kubermatic Kubernetes Platform contributors.


Please update other newly added files as well.

Suggested change

// Copyright 2024 The Kubermatic Kubernetes Platform contributors.

// Copyright 2025 The Kubermatic Kubernetes Platform contributors.

Waseem826 · 2025-01-14T08:04:58Z

modules/web/src/app/shared/components/announcement/template.html

+limitations under the License.
+-->
+
+<km-dialog-title>Announcement</km-dialog-title>


Suggested change

<km-dialog-title>Announcement</km-dialog-title>

<km-dialog-title>Announcements</km-dialog-title>

Waseem826 · 2025-01-14T08:06:31Z

modules/web/src/app/shared/components/announcement/template.html

+        class="km-mat-row"></tr>
+  </table>
+  <div class="km-row km-empty-list-msg"
+       *ngIf="hasAnnouncements()">No announcements available.</div>


This should will not be displayed if we don't have announcements which is the exact opposite of what we want here.

Waseem826 · 2025-01-14T08:07:36Z

modules/web/src/app/shared/components/announcement/template.html

+                mat-icon-button
+                (click)="markAsRead(element)"
+                fxLayoutAlign="center center">
+          <i Class="km-icon-mask km-icon-show"></i>


Lets change this icon to checkmark ✔️)

Waseem826 · 2025-01-14T08:09:13Z

modules/web/src/app/shared/components/announcement/component.ts

+    return !this.announcements?.size;
+  }
+
+  markAsRead(announcement: string): void {


I think instead of relying on parent component to update user settings, we should update them here. WDYT?

Waseem826 · 2025-01-14T08:09:58Z

modules/web/src/app/shared/entity/common.ts

@@ -106,6 +106,7 @@ export enum AdminPanelView {
  Defaults = 'defaults',
  Limits = 'limits',
  Customization = 'customization',
+  Announcement = 'announcement',


Same for the changes below.

Suggested change

Announcement = 'announcement',

Announcements = 'announcements',

ahmedwaleedmalik · 2025-01-15T15:05:01Z

I'd let @Waseem826 review the PR since he is already on it. Just a side-note, please don't forget to create a testing ticket for this.

kubermatic-bot · 2025-01-16T09:35:17Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from waseem826. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ahmadhamzh force-pushed the 6645-admin-announcement-feature branch from c497d5b to 0fdb818 Compare January 8, 2025 12:38

ahmadhamzh force-pushed the 6645-admin-announcement-feature branch from 17ca387 to 1b38c1b Compare January 9, 2025 14:13

ahmadhamzh changed the title ~~WIP Admin announcement feature~~ Admin announcement feature Jan 9, 2025

kubermatic-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 9, 2025

ahmadhamzh force-pushed the 6645-admin-announcement-feature branch from 1b38c1b to be40502 Compare January 10, 2025 08:50

Waseem826 self-requested a review January 10, 2025 15:01

Waseem826 added the needs-release-testing Denotes a PR or issue that needs to be tested before release. label Jan 10, 2025

Waseem826 requested changes Jan 14, 2025

View reviewed changes

kubermatic-bot assigned Waseem826 Jan 14, 2025

ahmadhamzh force-pushed the 6645-admin-announcement-feature branch from be40502 to 3e56a71 Compare January 16, 2025 09:09

ahmadhamzh added 4 commits January 16, 2025 12:11

add the admin announcement component

d20d6db

add-announcement-announcement-banner-components

c9d83f9

add-announcement-on-api

e5ea5d5

add rest of announcements feature

3933c04

ahmadhamzh added 2 commits January 16, 2025 12:13

Enhance functionality and fix some issues.

3fe3e9d

revert git add package-lock.json to main

7ecfa14

ahmadhamzh force-pushed the 6645-admin-announcement-feature branch from 3e56a71 to 7ecfa14 Compare January 16, 2025 09:35

ahmadhamzh requested a review from Waseem826 January 16, 2025 09:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Admin announcement feature #7067

Admin announcement feature #7067

ahmadhamzh commented Jan 8, 2025 •

edited

Loading

ahmadhamzh commented Jan 9, 2025

csengerszabo commented Jan 10, 2025

ahmadhamzh commented Jan 10, 2025

ahmadhamzh commented Jan 10, 2025

Waseem826 left a comment

Waseem826 Jan 13, 2025

Waseem826 Jan 13, 2025

Waseem826 Jan 13, 2025

Waseem826 Jan 13, 2025

Waseem826 Jan 13, 2025

Waseem826 Jan 14, 2025

Waseem826 Jan 14, 2025

Waseem826 Jan 14, 2025

Waseem826 Jan 14, 2025

Waseem826 Jan 14, 2025

ahmedwaleedmalik commented Jan 15, 2025

kubermatic-bot commented Jan 16, 2025

	<div *ngIf="adminSettings?.displayAPIDocs"
	<div *ngIf="adminSettings?.displayAPIDocs"

		@@ -0,0 +1,163 @@
		// Copyright 2024 The Kubermatic Kubernetes Platform contributors.

	// Copyright 2024 The Kubermatic Kubernetes Platform contributors.
	// Copyright 2025 The Kubermatic Kubernetes Platform contributors.

	<km-dialog-title>Announcement</km-dialog-title>
	<km-dialog-title>Announcements</km-dialog-title>

	Announcement = 'announcement',
	Announcements = 'announcements',

Admin announcement feature #7067

Are you sure you want to change the base?

Admin announcement feature #7067

Conversation

ahmadhamzh commented Jan 8, 2025 • edited Loading

ahmadhamzh commented Jan 9, 2025

csengerszabo commented Jan 10, 2025

ahmadhamzh commented Jan 10, 2025

ahmadhamzh commented Jan 10, 2025

Waseem826 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmedwaleedmalik commented Jan 15, 2025

kubermatic-bot commented Jan 16, 2025

ahmadhamzh commented Jan 8, 2025 •

edited

Loading