giveth-next icon indicating copy to clipboard operation
giveth-next copied to clipboard

Maintenance Mode

Open geleeroyale opened this issue 3 years ago • 23 comments

We need to do maintenance periodically to keep backend services and their dependencies up to date. Because we did not have too many users before we used to just to these maintenance procedures taking the risk to disrupt the session of one or two users. Now that the service has matured, we can't do that anymore. Users need to be informed about maintenance before and during the operations

My suggestion is to have three things:

  • [ ] always have maintenance happen in the same timeslot so affected users might anticipate the downtime. This was already agreed upon to be a possible weekly window at "Saturdays 12am GMT -6"
  • [x] Sync with the Communications team so they can inform users in time before the first maintenance period occurs
  • [x] Switch to maintenance mode on the frontend. Like mentioned before it would be great to have a simple fullscreen modal that informs users of ongoing maintenance and asks them to ... check back in a few minutes. Ideally we have a little hidden hotzone that lets us bypass the modal for testing. [Edit: Also - it would be awesome if we could trigger the maintenance modal just with an env value]

geleeroyale avatar Jan 10 '22 16:01 geleeroyale

Two first checkmarks should be approved by Comms Team. Just mention @WhyldWanderer and @laurenluz to prioritize it. the last checkmark: "Switch to maintenance mode on the frontend" can be done by @MohammadPCh , pls let me know if you need any design, etc.

MoeNick avatar Jan 10 '22 19:01 MoeNick

How long does the maintenance take @geleeroyale ?

We can add it to our documentation. @divine-comedian - maybe you can find the appropriate place while you're working on the docs.

@WhyldWanderer do you think we should send a one-time email from autopilot to let them know about this before the first time?

laurenluz avatar Jan 10 '22 22:01 laurenluz

Depends. Usually its very quick. The timeframes would vary over maintenance periods in the future. The most important point is to communicate it to users on the frontend so they don't interact with it while some backend service is down.

geleeroyale avatar Jan 10 '22 23:01 geleeroyale

Discussing it with the comms team, we don't think an email would be good because people are getting annoyed with them.

Can we instead add a banner on fridays that explains "maintenance coming soon"? @divine-comedian will write copy for this and the splash page.

laurenluz avatar Jan 12 '22 17:01 laurenluz

@markoprljic can you help with the design of the splashpage & warning banner?

laurenluz avatar Jan 12 '22 17:01 laurenluz

@markoprljic can you help with the design of the splashpage & warning banner?

Yes. cc/ @rodricastillo9013

markoprljic avatar Jan 12 '22 17:01 markoprljic

Here's some copy for ya :

Splash Page:

"Giveth.io is currently offline for scheduled maintenance! Check again in a few hours to dive back into the Future of Giving."

Banner:

"Giveth.io will be offline for scheduled maintenance starting on Saturday 12am GMT-6. The DApp will be inaccessible for several hours."

divine-comedian avatar Jan 12 '22 23:01 divine-comedian

@MohammadPCh is off on Fri and Sat, is there any chance we have the design sooner to get it implemented today @rodricastillo9013 ? I think we need it on Sat

MoeNick avatar Jan 13 '22 12:01 MoeNick

Hi perfect I'll get on with this now!

rodricastillo9013 avatar Jan 13 '22 17:01 rodricastillo9013

Header - Maintenance Home Maintenance

rodricastillo9013 avatar Jan 13 '22 17:01 rodricastillo9013

what do you think of these designs?

rodricastillo9013 avatar Jan 13 '22 17:01 rodricastillo9013

I'd use the same darker purpler on the second mockup (Splash page) and include logo and offer user to go to Medium or Youtube or somewhere else.

markoprljic avatar Jan 13 '22 18:01 markoprljic

ok i will make the changes

rodricastillo9013 avatar Jan 13 '22 18:01 rodricastillo9013

Home Maintenance2

rodricastillo9013 avatar Jan 13 '22 18:01 rodricastillo9013

What do you think? @markoprljic

rodricastillo9013 avatar Jan 13 '22 18:01 rodricastillo9013

Nice.

@divine-comedian owns this issue, please review and approve.

markoprljic avatar Jan 13 '22 18:01 markoprljic

https://www.figma.com/file/nVoinu0tgJ565enN5R4WDE/Giveth.io-%26-GIVeconomy?node-id=2%3A66

rodricastillo9013 avatar Jan 13 '22 18:01 rodricastillo9013

While we're at this, I think we need other error pages 404, 501 etc https://www.presslabs.com/how-to/error-pages/

Let's create a section in Figma and put them all there.

markoprljic avatar Jan 13 '22 18:01 markoprljic

ok! nice! perfect

rodricastillo9013 avatar Jan 13 '22 19:01 rodricastillo9013

@rodricastillo9013 @markoprljic looks great! I think @MohammadPCh can start

divine-comedian avatar Jan 14 '22 11:01 divine-comedian

@MohammadPCh pls check the last checkbox in the description when it's completed. (It needs both on giveth.io & givEconomy)

MoeNick avatar Jan 18 '22 09:01 MoeNick

Hi! here I leave the link where I have created all the error pages, any comment is welcome, if we need any more specific let me know

https://www.figma.com/file/nVoinu0tgJ565enN5R4WDE/Giveth.io-%26-GIVeconomy?node-id=3934%3A106532

rodricastillo9013 avatar Jan 19 '22 22:01 rodricastillo9013

Thanks @rodricastillo9013

MoeNick avatar Jan 19 '22 22:01 MoeNick