Fix all broken links and add link checker #108
Conversation
Following configuration from alphagov/tech-docs-template#187
This is to avoid the two locations falling out of sync and to avoid having to raise PRs in two repos for some types of changes.
Now that we have all content in one place (previous commit), we don't need the gem_docs helper to bring the content in from the gem repo.
We moved the text in a previous commit, we should move the screenshots for the text, too.
There's no reason to have separate folders for 'screenshots' and 'diagrams'.
PR for the move into `tdt-documentation`: alphagov/tdt-documentation#108
|
A very minor (and existing) thing that'd be good to fix at some point but shouldn't block this – there's a mix of wrapped and non-wrapped lines within and across all the files. It'd be good to try and make it consistent at some point. |
|
|
||
| # Configuration options | ||
|
|
||
| <%= gem_docs 'configuration.md' %> |
There was a problem hiding this comment.
Does this mean we need to do a pull request on the gem repo to remove content?
There was a problem hiding this comment.
This is the PR to add signposting for the content move: alphagov/tech-docs-gem#151
There was a problem hiding this comment.
Yup - I've raised this PR to cover the content move: alphagov/tech-docs-gem#151
@36degrees I've raised an issue to keep track of this: #109 |
Context
As a result of the change in docs structure (#97), a number of links broke.
Changes proposed in this pull request
Manually fix broken links and add a link checker such that the build will fail if there are any broken links. This should make sure future changes to the docs will not lead to more broken links.
The PR also copies the docs content from the tech docs gem: https://github.com/alphagov/tech-docs-gem/tree/master/docs. This content is currently copied over and updated on every build through the
gem_docshelper method. The fragmented setup makes it hard to make changes that involve that content. The plan is to eventually move everything in thealphagov/tdt-documentationrepo to the tech docs gem repo.There will be a PR signposting the content move inThis is the PR to add signposting for the content move: alphagov/tech-docs-gem#151alphagov/tech-docs-gem/docsGuidance to review
Run build locally.
html-proofershouldn't find any broken links.