Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation hosting in GOV.UK PaaS #210

Open
TheDoubleK opened this issue Dec 15, 2023 · 1 comment
Open

Documentation hosting in GOV.UK PaaS #210

TheDoubleK opened this issue Dec 15, 2023 · 1 comment

Comments

@TheDoubleK
Copy link

What should change

The documentation should be hosted somewhere other than GOV.UK PaaS, on a domain other than london.cloudapps.digital.

Identifying a user need

GOV.UK PaaS is being decommissioned imminently, at which point the current documentation website will go offline. For users who need to refer to the documentation beyond the PaaS switch-off setting up hosting elsewhere will meet that need.

@MatMoore
Copy link

MatMoore commented Mar 27, 2024

Hi @TheDoubleK, is there anyone currently maintaining this project who would be able to move this across to Github pages?

The current situation is the old page just redirects to the github repository. If you arrive at the tool via https://github.com/alphagov/tech-docs-template you are just sent round in circles, so it looks like this project is abandoned.

It wouldn't take more a day's work from a developer to set this up. MOJ already have open code to publish sites built with the tech docs template to github pages
and I was able to publish a fork to https://matmoore.github.io/tdt-documentation/ using that.

MatMoore added a commit to ministryofjustice/find-moj-data-user-guide that referenced this issue Oct 29, 2024
The tech docs template's own documentation has been missing since
GOV.UK decommissioned GOV.UK PaaS in 2023.

See alphagov/tdt-documentation#210
MatMoore added a commit to ministryofjustice/find-moj-data-user-guide that referenced this issue Oct 29, 2024
The tech docs template's own documentation has been missing since
GOV.UK decommissioned GOV.UK PaaS in 2023.

See alphagov/tdt-documentation#210
MatMoore added a commit to ministryofjustice/find-moj-data-user-guide that referenced this issue Oct 29, 2024
The tech docs template's own documentation has been missing since
GOV.UK decommissioned GOV.UK PaaS in 2023.

See alphagov/tdt-documentation#210
MatMoore added a commit to ministryofjustice/find-moj-data-user-guide that referenced this issue Oct 29, 2024
The tech docs template's own documentation has been missing since
GOV.UK decommissioned GOV.UK PaaS in 2023.

See alphagov/tdt-documentation#210
MatMoore added a commit to ministryofjustice/find-moj-data-user-guide that referenced this issue Oct 29, 2024
…cker (#30)

* update to v4 of tech docs publisher

The old link checker is no longer included, so use lychee instead.

* fix: remove dead links from the readme

The tech docs template's own documentation has been missing since
GOV.UK decommissioned GOV.UK PaaS in 2023.

See alphagov/tdt-documentation#210

* fix: simplify directory structure

For the link checker to work, the directory structure must mirror the
directory path structure of the final site.

Since we had two parallel directory structures, `source`,
containing erb, and `source/documentation`, containing markdown,
and those structures were slightly inconsistent, we ended up in the case
where a relative link in the markdown could not be resolved
by the link checker, even though the link worked when the documentation
was published.

There is really no need to have a parallel file structure just to
include markdown files. Middleman (which the tech docs template is based
on) will happily mix erb files with the
extension `.html.erb` or `.html.md.erb` and markdown files with the
extension `.html.md`. In fact, we don't rely on erb at all, so we can
just name our files `.html.md`.

* Update to v5 and add phase banner

Update the tech docs publisher to v5.

This upgrades to govuk frontend v5.7.1.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants