Regulations Search - contingency code/messaging if eCFR API is down - Githubissues

fecgov / fec-cms

The content management system (CMS) for the new Federal Election Commission website.

https://www.fec.gov

Other

93 stars 38 forks source link

Regulations Search - contingency code/messaging if eCFR API is down #6272

Open johnnyporkchops opened 4 months ago

johnnyporkchops commented 4 months ago

Summary

What we're after: Mitigate any degradation in user-experience caused if the eCFR is down or not returning useful data

Page: https://stage.fec.gov/regulations/

What will happen on the Regulation search page if eCFR API is unreachable or does not return parseable data
Do we need conditional code to control what the user sees on the Regulations search page in the event that eCFR is down
How would we word any messaging we put on Regulation search page in the event that eCFR is down

Related issue:

[ ] https://github.com/fecgov/fec-eregs/issues/826#issuecomment-1939134277

Related PR:

https://github.com/fecgov/fec-cms/pull/6190

Completion criteria

[ ] Document what happens, if anything, on the Regulations search page in the event that sCFRis down or not returning useful data
[ ] Conditional code to detect unsuccessful calls to the eCFR API from the Regulations search data table
[ ] Contingent messaging is rendered to the page to alert users of how the outage may affect search results
[ ] Language for messaging is written and approved