Project

General

Profile

Actions

Feature #21710

closed

Maintenance page design and language for Reclaim migration

Added by Boone Gorges 3 months ago. Updated 5 days ago.

Status:
Resolved
Priority name:
Normal
Category name:
-
Target version:
Start date:
2025-01-07
Due date:
% Done:

0%

Estimated time:
Deployment actions:

Description

Here's our existing maintenance page (note that this is on the GC server, not on Reclaim): https://commons.gc.cuny.edu/maintenance-test.html

We want to do the following;

1. Colin will come up with language that explains that we're down for a hosting migration, with links to external posts etc as needed. My one recommendation is to point to something that lives on the status blog or elsewhere on the web, since the Commons itself will be unavailable.
2. Sara will do a simple design refresh so that the page matches our current identity
3. Ray will implement. Ray, please put things in the reclaim-migration branch on GitHub.


Files

texture.png (165 KB) texture.png Sara Cannon, 2025-01-08 12:02 PM
CAC-logo-stacked.png (27.5 KB) CAC-logo-stacked.png Sara Cannon, 2025-01-08 12:02 PM
Under Construction.png (923 KB) Under Construction.png Sara Cannon, 2025-01-08 12:02 PM
maintenance.html (108 KB) maintenance.html Raymond Hoh, 2025-01-08 03:11 PM
maintenance.html (108 KB) maintenance.html Raymond Hoh, 2025-01-10 12:38 AM
Screenshot 2025-01-17 at 6.22.19 PM.png (161 KB) Screenshot 2025-01-17 at 6.22.19 PM.png Colin McDonald, 2025-01-20 05:43 PM
Actions #1

Updated by Colin McDonald 3 months ago

I just published an "upcoming downtime" post on the status blog:

https://commonsstatus.wordpress.com/

I slightly modified the language I just drafted in the forum for wider communication about the migration. I'll edit it as needed, but it seemed good to get something up for now.

I'm inclined to just keep linking to the status blog homepage, as opposed to a specific post, as we redesign this maintenance splash page. That way everyone will hopefully see the latest updates pretty easily.

For the splash page text itself, is it doable enough to change the text to something migration-specific for Jan 15, since the downtime is so notable? Then we could get the key info right on that page, something like:

"The CUNY Academic Commons is offline while we migrate to a new hosting provider. The process began at 10:30am Eastern on Wednesday, January 15th and will take 48-72 hours to complete because of the size and complexity of the data involved.

Please check our status blog (link:https://commonsstatus.wordpress.com) for the latest updates. Thank you for your patience as we take this important step for the stability and improvement of the Commons."

Let me know if you think we should just go with an updated but generic offline message instead. Either way, we could plan to use something like this post-migration:

"The CUNY Academic Commons is offline for maintenance. Our team is working to restore the site as soon as possible.

Please check our status blog (link:https://commonsstatus.wordpress.com) for the latest updates, and thank you for your patience."

Actions #2

Updated by Boone Gorges 3 months ago

Yes, we can have something specific to the migration on the maintenance page, and IMHO it's a good idea to do so.

Actions #3

Updated by Matt Gold 3 months ago

Thanks so much, Colin. The post looks great. I think we should maybe add the help address so that people can email us if they have concerns/questions.

Perhaps one other thing we might want to mention is all content added to the Commons ahead of the downtime will be migrated to the new host. People may have questions/concerns about that, and/or they might not know/understand what a hosting migration means

Actions #4

Updated by Colin McDonald 3 months ago

Thanks, Matt. I'm going to start finalizing and posting outreach, also as per my forum post here:

https://commons.gc.cuny.edu/groups/cac-community-team-project-planning/forum/topic/host-migration-communications/

I will add the note about preserving and migrating all content. Part of me didn't want to even bring that up, at the risk of worrying users who hadn't considered it, but on second thought it seems better to say too much on that front and cut any concern off at the pass.

Actions #5

Updated by Sara Cannon 3 months ago

Attached is a simple under-construction page that has Colin's updated wording along with the assets.

Actions #6

Updated by Raymond Hoh 3 months ago

I've quickly put together the new HTML maintenance page. Please download the attachment and load it in your web browser for testing. I've added a few mobile breakpoints, but let me know if anything looks out-of-place.

A few dev notes: The texture and CAC logo are already included in the HTML file as inline images. The Poppins and Merriweather fonts are loaded externally via the Google Fonts CDN.

Actions #7

Updated by Matt Gold 3 months ago

Thank you, Ray and Sara! Looks great!! So much better. One small note -- can you please edit

we take this important step for the stability and improvement of the Commons.

to

we take this important step to improve the stability of the Commons.

Actions #8

Updated by Colin McDonald 3 months ago

Looks great to me, too! And thanks for the copy edit, Matt.

Actions #9

Updated by Raymond Hoh 3 months ago

I've updated the maintenance page with Matt's copy and also with some mobile breakpoint fixes. For those that want to test locally, I've attached the maintenance.html file; I've also uploaded the page to the GC servers for easier testing: https://commons.gc.cuny.edu/maintenance-reclaim.html.

Boone, for the reclaim-migration branch, did you want me to overwrite the existing maintenance.html file or did you want to use a different filename?

Actions #10

Updated by Boone Gorges 3 months ago

Boone, for the reclaim-migration branch, did you want me to overwrite the existing maintenance.html file or did you want to use a different filename?

Let's use the same filename - there's no reason to keep the old one around. After the migration, we can change the language in that file to be more general.

Actions #11

Updated by Raymond Hoh 3 months ago

  • Status changed from New to Staged for Production Release

Gotcha! I've added the new maintenance page to the reclaim-migration branch in https://github.com/cuny-academic-commons/cac/commit/90e46bad19b7ff1fa366fdc48ea5a35fceb03966.

Actions #12

Updated by Boone Gorges 3 months ago

  • Status changed from Staged for Production Release to Resolved
Actions #13

Updated by Colin McDonald 3 months ago

This is far down the list, just working through some notes I have made the past few days. I was wondering how the automatic maintenance page works now that we're on Reclaim. Will it always default the newly designed one? I screengrabbed the attached one on Friday at 6:30pm as we were working through launch issues. In some cases, are we tied to the more technical and less friendly Cloudflare page?

Actions #14

Updated by Raymond Hoh 3 months ago

It looks like it might be possible to customize the Cloudflare error page: https://developers.cloudflare.com/support/more-dashboard-apps/cloudflare-custom-pages/configuring-custom-pages-error-and-challenge/, but this feature is only available to Cloudflare Pro, Business, or Enterprise plans. We'd have to reach out to Reclaim to see if this is possible.

Actions #15

Updated by Matt Gold 3 months ago

Thanks, Ray. As Colin says, this is not urgent, but we probably should reach out to Reclaim about it when things calm down a bit

Actions #16

Updated by Colin McDonald about 2 months ago

As mentioned on the dev call yesterday, I'll copy over the latest from the support thread we have going with Reclaim about this soon. I think we might be getting closer to a resolution with them there, though, so I might wait on that a little longer.

In the meantime, I saw that one challenge is finding a way to test whether a new maintenance page is working as it should, since it's hard to replicate site downtime. However, as part of #22053 I just tried twice to clone the Help & Support site, and each time I ended up at the default Cloudflare timeout screen after a couple of minutes of the site presumably trying and failing to clone. Thought that might be helpful.

Actions #17

Updated by Colin McDonald 5 days ago

Latest from Reclaim on enabling the custom maintenance/downtime page:

The feature we have enabled on your prod is "Enable Origin Error pages" in Cloudflare. This simply allows the error pages that are served by the web server to be "passed through" and work as if they weren't served by Cloudflare. This is a feature exclusive to Cloudflare's Enterprise tier, which is what you all have on commons.gc.cuny.edu. Unfortunately, we do not have that plan or this feature available on reclaimhosting.dev, so we can't enable this feature on your dev site.

https://support.reclaimhosting.com/hc/en-us/articles/1500011279141-Pointing-localhost-File-to-Preview-Site

As a workaround, we could have you all point your hosts file for the dev site, effectively bypassing cloudflare, for the purpose of testing your error pages instead. If that works for you all we'll just need to know your IP address, so we can whitelist it in the firewall for direct web traffic to the dev server. Let us know if you want to pursue this option.

Actions #18

Updated by Jeremy Felt 5 days ago

It seems like the "enable origin pages" feature Reclaim has enabled on Cloudflare would work for 5xx errors, but I wouldn't expect it to work for timeouts.

It also seems like a Cloudflare worker powered page would work for this. https://developers.cloudflare.com/rules/snippets/examples/maintenance/

I've done a very small amount with Cloudflare workers to route certain requests to a different server. They're kind of annoying to get going, especially if you don't stop to understand what you're doing. But, once it's up and running it doesn't really need any maintenance. I think this fits in the category of: "if we controlled Cloudflare, we could get this done fairly quickly", but I'm not sure we'd really want to take that step. :)

Actions

Also available in: Atom PDF