equinor / energyvision

Home of the equinor.com website
https://www.equinor.com
MIT License
32 stars 8 forks source link

Provide html for backup site in Radix #1352

Closed nilsml closed 1 year ago

nilsml commented 1 year ago

In order to give the user a proper message when our pods are down, we need to come up with design/markup for a backup page

This page will be shown whenever none of our pods for equinor.com are working

fernandolucchesi commented 1 year ago

Duplicate of #1278 https://github.com/equinor/radix-platform/issues/747, I'll close the first one since this has better description

fernandolucchesi commented 1 year ago

@NickHaggerty1

NickHaggerty1 commented 1 year ago

@fernandolucchesi @nilsml
No idea on this... Sizes? Requirements? Text? Image? And I assume you guys great the html?!

NickHaggerty1 commented 1 year ago

@fernandolucchesi @nilsml
No idea on this... Sizes? Requirements? Text? Image? And I assume you guys create the html?!

nilsml commented 1 year ago

There are no specific requirements other than having a nice page with a message to the user.

Something in the lines of:

"It seems like we are having some issues with our site. Our deepest apologies! Please try again in a few minutes, and hopefully we have sorted out our problems by then" 🤷🏻‍♂️

NickHaggerty1 commented 1 year ago

Could you build in Sanity like 404 page, so editor adds image and text in? If so, cant we just base it on the 404 set up and we manually add the text and image?

Or is this something different?, if so, I would need answers for the other 4 questions...

fernandolucchesi commented 1 year ago

This is the page to be shown up when our website/infra is down. From what I can remember that was discussed during the disaster recovery meetings, there should be links to our social media communication channels, because in case of a black screen users would be able to find more information through these channels

fernandolucchesi commented 1 year ago

Could you build in Sanity like 404 page, so editor adds image and text in? If so, cant we just base it on the 404 set up and we manually add the text and image?

Or is this something different?, if so, I would need answers for the other 4 questions...

this shouldnt be a sanity page... is a page for when everything breaks, has to be hardcoded 😬

fernandolucchesi commented 1 year ago

I think it should have a "Keep calm" message approach, more of a copywriting than design to be done here IMO. On the feature request to radix I explained a bit of the context:

Is your feature request related to a problem? Please describe. Equinor.com is a business critical application. It might happen, as it has happened on the incident of 30th August, that the website has a downtime due to different reasons (azure, radix, our own code etc). With the current default error page "503 Service Temporarily Unavailable" our users are not informed about what is happening.

Describe the solution you'd like We would like to have a custom error page with support to anchor links, in order to direct our users to different communication channels (facebook/twitter/status page), where they will be able to find information about the downtime, minimising speculations.

Describe alternatives you've considered Fallback DNS to another address when radix server responds with error.

Additional context During the downtime we had, the Equinor @ONS 2022 event was happening, and journalists asked Equinor employees if we were under attack by Russian hackers 😅. We want to minimize as much as we can that such incidents affects Equinor's reputation, specially if such happens around Quarterly Results publications for investors.

NickHaggerty1 commented 1 year ago

image.png

NickHaggerty1 commented 1 year ago

Just to get the ball rolling here. Something like this? Optional to have logo? Make it look a little more correct. Suggestion on text. As you mentioned above in the dialogue, provide links to some....

SvSven commented 1 year ago

Looks beautiful ♥

SvSven commented 1 year ago

@fernandolucchesi @padms @millianapia Code can be found in the newly created radix folder - you can test it locally by running pnpx serve . from that folder.

@NickHaggerty1 I made some slight changes to the text/design:

Desktop:

image.png

Mobile:

image.png

SvSven commented 1 year ago

Should be said that hopefully no one ever gets to see this page - it's purely to replace the default one that would site in the (mostly unlikely) scenario that the whole site crashes.

SvSven commented 1 year ago

Also, limitations as mentioned by the Radix team:

Currently there are some limitations:

  1. CSS and JS need to be implemented inside the HTML file.
  2. Any photos or other files needs to be Base64 Encoded.

Hence why the favicon, the logo, and icons are all inline SVG (with the favicon being a URL encoded SVG - never knew that was possible)

millianapia commented 1 year ago

Also, limitations as mentioned by the Radix team:

Currently there are some limitations:

  1. CSS and JS need to be implemented inside the HTML file.
  2. Any photos or other files needs to be Base64 Encoded.

Hence why the favicon, the logo, and icons are all inline SVG (with the favicon being a URL encoded SVG - never knew that was possible)

Nice workaround! looks good

meols commented 1 year ago

@SvSven - is there anything to be tested for this one, and if so, any acceptance criteria?

SvSven commented 1 year ago

@meols @NickHaggerty1 Nothing to be tested - just need to be confirmed that the text and the design on the screenshot I posted above is good.

NickHaggerty1 commented 1 year ago

Great Sven, good to goooooooo

SvSven commented 1 year ago

Perfect

@fernandolucchesi how do we get this to the Radix team - you have a contact with them I believe?

nilsml commented 1 year ago

omnia_radix_support channel on Slack is the easiest way to reach them @SvSven

fernandolucchesi commented 1 year ago

Perfect

@fernandolucchesi how do we get this to the Radix team - you have a contact with them I believe?

Magnus Longva is usually my go-to guy in radix team

SvSven commented 1 year ago

Radix team has deployed the custom error page for our cluster: https://github.com/equinor/radix-platform/issues/747#issuecomment-1334855980