eAPD icon indicating copy to clipboard operation
eAPD copied to clipboard

[Design Issue] Create Maintenance page

Open thetif opened this issue 2 years ago • 6 comments

Now that we are using LaunchDarkly, we could easily flip on a maintenance page if something goes wrong with the application. Create a page that we could display to the user when the system is down for updates or errors.

This task is done when…

  • [x] designs have made created for a maintenance page
  • [x] 508 visual, content, and UX considerations and/or recommendations are reviewed
  • [x] designs are shared
  • [ ] designs are approved by product
  • [ ] if there is a long discussion, a summary of changes for dev will be added to the last comment before transfer
  • [ ] a list of changes to be made if this is improving an existing feature

thetif avatar Dec 01 '22 20:12 thetif

Closing Notes

As of April 12th 2023 FYI System outage/schedule maintenance help text comes from the eAPD Inquiry Response Document that Caryn wrote.

Scheduled Maintenance Workflow: User access the eAPD before and during a scheduled maintenance.

  1. An information alert will be displayed within ours of days of when it is needed. Around the same time we will need a message in the eapd-user-support channel the day before, depending on the severity/urgency, as it has been done before.
  2. The alert will be on the login/logout and dashboard pages. I did not include it in the builder because I thought it would be overkill and the other maintenance pages I saw for reference kept the alerts on the homepages and logins.
  3. If a user is logged in an working on an APD right before the schedule maintenance and during, the page will turn gray and present the unable to make changes modal alerting users of a scheduled maintenance
  4. Source of illustration : Online illustrations by Storyset

Scheduled Maintenance Workflow: User access the eAPD after the start of a schedule maintenance.

  1. We will turn on the schedule maintenance so that would be the 1st page users see instead of the login page. If they use a url for the builder they would have the same experience of being directed to the system outage page.
  2. This page will be active until the maintenance is over. I don’t think we need session timeout here.

Unscheduled/unexpected System Outage : A unexpected system outage occurs while a user is in the system, then eAPD is notified

(Out of scope of this ticket but I wanted to create it because it is not much different)

  1. User logs in and access an APD, they experience the unable to make changes and know that they have internet connection, so they either email or slack message that they cant edit, notifying eAPD that the system is down. Alternatively, internally we can realize that the system is down and notify slack and update the website.
  2. First they experience the unable to save changes, once we know we turn on the system outage page until the issue is resolved.

akuas avatar Apr 06 '23 14:04 akuas

@jeromeleecms @stephanieboydcms @SGilliamA1M This ticket is ready to review. I still need to ask Tif questions about how certain aspects would work, next week, so this is not a final review or anything.

akuas avatar Apr 06 '23 18:04 akuas

Thanks @akuas! Designs look great. I dropped a comment regarding restricting users from logging in while system maintenance is in progress. A few reasons we should consider in support of this cause:

  1. It prevents users from expecting that after logged in, they would be able to engage with/navigate the system as usual.
  2. Logs configured on the backend for tracking are often limited during system maintenance.

@jeromeleecms and @stephanieboydcms - any thoughts on this? @thetif - can you weigh in on this from a technical perspective?

SGilliamA1M avatar Apr 11 '23 16:04 SGilliamA1M

Okay this is ready for review again :) @stephanieboydcms @jeromeleecms

akuas avatar Apr 12 '23 16:04 akuas

Good on my end @akuas

stephanieboydcms avatar Apr 20 '23 16:04 stephanieboydcms

Just need to spin up what the dev implementation looks like ;)

jeromeleecms avatar Apr 21 '23 15:04 jeromeleecms