-
Notifications
You must be signed in to change notification settings - Fork 8
Replace manuals accordion with gem accordion #1060
Replace manuals accordion with gem accordion #1060
Conversation
ea745fb
to
2030c05
Compare
2030c05
to
d0bc6bb
Compare
d0bc6bb
to
d4889b9
Compare
d4889b9
to
2f6cbe7
Compare
Note on testsEnd to end test are currently failing. This is because this PR introduced a test failure in the publishing-e2e-tests repo due to the significant change in markup. I've created a separate PR to handle this. As per the e2e contribution guidance, once this has been reviewed and approved I'll set this branch to test against my e2e branch, merge my changes, deploy and then merge my e2e PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - but made some code quality suggestions below.
I'd also amend the last commit to include the context you provided on Slack around why you're removing Jasmine 👍
2f6cbe7
to
2b9062e
Compare
2b9062e
to
d1cbc7e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍 thanks for making the changes! One or two non-blocking comments below:
d1cbc7e
to
b9b5f54
Compare
As this is now using the gem accordion where there are already jasmine tests, any tests here would just be replicating effort. There's now no point in jasmine being part of this repo as there aren't any js modules to test.
b9b5f54
to
d52faee
Compare
What
Replace the custom manuals accordion (collapsible collection) with the components gem accordion. This includes:
Why
This is part of work within the govuk accessibility team to ensure that accordions are consistent across gov.uk. Manuals frontend has been using a bespoke accordion implementation which bolts on accordion functionality on top of govspeak content from manuals publisher. This creates risk because any updates to our accordion can't reliably permeate to manuals and could create hidden legacy code and accessibility issues. This change creates a relationship between manuals and our components gem, as is the case with our other frontend apps, to minimise risk and increase consistency between manuals and the rest of gov.uk.
The team are conscious that this is, in a sense, perpetuating the hack and the ideal would be to change the publishing workflow to account for accordion content, thus mitigating the need for any sort of preprocessing of the content item. We don't have the resource or knowledge in the team to action this, however an issue has been raised addressing this need.
Card
Pages tested against
Visual changes
Before
After