Tech-doc-publisher repo: Bug fix attempt

[NickWalt01]

Background

The tech-doc-repo is using Ruby 2.7, and we couldn't update the repository until the Middleman tool supports Ruby 3, this has now been updated. This ticket is to bump the Ruby to use 3.1, and any other dependencies that can be bumped. The aim is to see if the problem in this issue is resolved or not. If it is create a new release of the tech-doc-publisher.

'There's now a release of Middleman with support for Ruby 3.1 - v4.5.0. In theory, this bug should be fixed on middleman 4.5.0, but I haven't tested it yet.'

Proposed user journey

• Read the history in this issue
• Read the README.md to understand how to use the tool
• Update Ruby to 3.1
• Update Middleman and haml to a newer version
• Update the Docker base image version
• Locally with the ops-eng repo and the tech-doc-publisher repo attempt to build the documentation, then try different date types (2021/02/23, 2021-02-23, etc)at the top of a document and see if the issue still exists.
• Check the output to see if there are any exceptions.
• If the issue is solved then update the html-proofer tool and see if it any better as a url check tool within the script files
• Create a new release on the tech-doc-publisher
• In the ops-eng repo makefile, use the new image version and run it locally, ensure the docs still work and that the bottom of the runbook page the blue box appears that states the doc is in date or a red box if the doc is out of date. This will prove it is working, when the exceptions occurs the blue or red box is not visible at the bottom of the document screen.
• In the ops-eng repo, use the new release in publish.gh, run the gh pages gh action on the ops-eng repo, and do the same check in production.
• Do the same on the tech-guidance repository

[NickWalt01]

Another team have attempted the bug fix on their doc repo and stated the issue is resolved for them. See PR for more info.

[NickWalt01]

See if the Ruby gem version 3.4 helps with the problem: https://rubygems.org/gems/govuk_tech_docs

[AntonyBishop]

Park for now