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

External link checking with HtmlProofer errors when creating new pages #226

Open
mrwilson opened this issue Jul 21, 2022 · 2 comments
Open

Comments

@mrwilson
Copy link

If external link checking is enabled with HtmlProofer, the next page created will cause the link checker to fail when using auto-generated links to the page source.

This is because the page source link does not yet exist in source control, but does exist in the branch, so the HtmlProofer fails.

We patched this in di-authentication-tech-docs by ignoring any links related to the source repo url.

https://github.com/alphagov/di-authentication-tech-docs/blob/main/config.rb#L24

@laurahiles laurahiles moved this from Reviewer approved to Review in Technical Documentation Template project board Jul 21, 2022
@PippaClarkGDS PippaClarkGDS moved this from Review to Looking for people to progress in Technical Documentation Template project board Jul 21, 2022
@PippaClarkGDS PippaClarkGDS moved this from Looking for people to progress to Backlog in Technical Documentation Template project board Jul 21, 2022
@PippaClarkGDS
Copy link

Action for this: we would need the consideration to add it as an optional extra - something that can be turned on in the config. Possibly bundle it with the tech docs gem with some sensible defaults, have a flag to turn it on, and another flag to override the configuration.

@laurahiles laurahiles moved this from Backlog to Prioritised backlog in Technical Documentation Template project board Jul 21, 2022
@lfdebrux
Copy link
Member

lfdebrux commented Oct 7, 2022

Related to #186, where we also look at putting html-proofer in the template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

3 participants