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

Investigate why a pair of broken links were not picked up by CI #7

Closed
samccann opened this issue Aug 5, 2022 · 1 comment
Closed
Assignees

Comments

@samccann
Copy link

samccann commented Aug 5, 2022

per Matt Clay's request:
ansible/ansible#78424

Fixes a broken reference. The question is - why was this problem not picked up by the ansible/ansible CI infrastructure.

@samccann samccann self-assigned this Aug 5, 2022
@samccann
Copy link
Author

samccann commented Aug 5, 2022

Near as I can tell, rstcheck doesn't validate for a well-formed URI inside the hyperlink. The docutils spec for RST is here - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases
The links that are quietly broken (not found by CI), are as follows:
Control Node Requirements <:ref:control-node-requirements>_
So it has a title (Control Node Requirements) and a URI . So if nothing acutally checks the blablabla, the test passes.
That syntax is used for external links. The internal link syntax is :ref:Control Node Requirments <blablabla>
and if that were incorrect, rstcheck would flag it.
So a correct external link would be Control Node Requirements <http://docs.ansible.com/blablbla>_
aka it was a clever way of combining the two to seem like it would work, but didn't, and didn't fail tests either

@samccann samccann closed this as completed Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant