tech-docs-gem
tech-docs-gem copied to clipboard
Upgrade to use govuk-frontend v5
What’s changed
- updated asset pipeline and packages used to be able to import govuk-frontend v5
- new
govuk_frontend_allentry point that importsall.bundlefrom govuk-frontend - updated javascript and sass compilers
- updated location paths for govuk-frontend
- updated markup as per govuk-frontend release notes
Identifying a user need
These changes serve two purposes:
- bring tech-docs frontend dependencies up to date from a maintenance / upgradability point of view
- bring with it some WCAG 2.2 compliance govuk-frontend offers so that when it comes to assessment / audit, we're in a better position
How to review / test
See individual commits for more detail Test in a downstream project:
- clone tech-docs-gem and switch to this branch
- create a
govuk_frontend.jsfile in project’ssource/assets/javascripts directory - add
//= require govuk_frontend_allinto it - point to local gem https://github.com/alphagov/tech-docs-gem/tree/use-govuk-frontend-v5?tab=readme-ov-file#use-your-own-tech-docs-template-website
- run
bundle install run bundle exec middleman serverorbuild