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.

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

UI: Admin Site Maintenance Notifications #100

Closed
5 tasks
schmelz21 opened this issue Mar 19, 2024 · 2 comments · Fixed by #148
Closed
5 tasks

UI: Admin Site Maintenance Notifications #100

schmelz21 opened this issue Mar 19, 2024 · 2 comments · Fixed by #148
Assignees
Labels
backend frontend improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@schmelz21
Copy link
Collaborator

schmelz21 commented Mar 19, 2024

💡 Summary

The Admin site maintenance tool should allow administrators to manage site maintenance messages. And create a method to issue a site management page. These messages will be displayed to users during scheduled maintenance on the login page and/or when there are critical update a maintenance page will display.

Motivation and context

This is valuable to streamline the maintenance processes for Crossfeed.

Implementation notes

  • Create/Edit/Delete Messages: Administrators can create, edit, and delete maintenance messages.
  • Scheduled Messages: Ability to schedule messages for specific dates and times.
  • Display Messages: Messages are prominently displayed to users during maintenance periods.
  • Notification System: Optionally, provide a notification system for users to be informed about upcoming maintenance.

No active or inactive notifications screen
image

Active notification and inactive notifications
image

Add New notification card and validation
image
image

Update notification pop up and validation
image
image

Acceptance criteria

  • Document all end-point changes
  • Demonstrate a Response Design
  • Include Screenshots Of Updated Views
  • Commit to Staging
  • Create Functional Tests
@schmelz21 schmelz21 added improvement This issue or pull request will add or improve functionality, maintainability, or ease of use backend frontend labels Mar 19, 2024
@ameliav
Copy link
Contributor

ameliav commented Mar 29, 2024

Will go back to task #133 first but will jot down my notes on I think may be appropriate fields for a table that will need to be added to the database as well as back-end endpoints to update maintenance messages.

Fields for a data table (to be vetted):

  • Field name, data type, allowed fields (if applicable)
  • id, string
  • maintenanceType, string, minor/major
  • status, string, active/disabled
  • updatedAt, date
  • updatedBy, email
  • message, string

Example data:

[
    {
        "id": 1,
        "maintenanceType": "minor",
        "status": "active",
        "updatedAt": "2024-03-26 21:34:17.304",
        "updatedBy": "[email protected]",
        "message": "Crossfeed has scheduled minor server maintenance on 3/28/2024 from 8:00AM to 5:00PM. Access to your Crossfeed settings will be limited. We apologize for the inconvenience. For further information, please reach out to [email protected]."
    },
    { 
        "id": 2,
        "maintenanceType": "major",
        "status": "disabled",
        "updatedAt": "2024-03-26 21:34:17.304",
        "updatedBy": "[email protected]",
        "message": "Crossfeed has scheduled major server maintenance from 3/28/2024 8:00AM to 3/29/2024 5:00PM. Access to Crossfeed will be disabled. We apologize for the inconvenience. For further information, please reach out to [email protected]."
    }
  ]

@ameliav ameliav changed the title UI: Admin Site Maintenance Tool UI: Admin Site Maintenance Notifications Apr 2, 2024
@ameliav ameliav linked a pull request Apr 2, 2024 that will close this issue
12 tasks
@ameliav
Copy link
Contributor

ameliav commented Apr 4, 2024

Designed a potential maintenance notifications interface. Need to know if this is going in the right direction, how many possible notifications there will be at a time, and what the exact fields to save should be.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend frontend improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants