-
Notifications
You must be signed in to change notification settings - Fork 68
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
Test link checker with respect to hard-coded guide URLs #947
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
@elasticmachine run docs-build |
Seems like the CI check is stuck, so I've relaunched it. |
Nice! → |
Looks like the link checker doesn't like the fourth or fifth examples:
I'll add one more to test a markdown-formatted link in that markdown section. |
It seems it's not fond of the markdown format either. :-(
Shall we try just a plain URL with nothing after it, similar to the example you found?
(using a different link so we can see if that one fails or not) |
Actually I don't think it minded the markdown-formatted link, since it didn't generate an error on that one. However, because of the other errors, I can't tell what it does with that URL. Probably nothing, which might be okay. |
Oh, sorry. I thought this one |
You're right, I missed seeing the additional error for the markdown-formatted links. The same failures occurred when I was doing similar fixes in elastic/security-docs#4847 |
I completely missed that these links appear in codeblocks and so might not be meant to be clickable. 😊 I didn't want to lose the CI results from this PR, so here's another one that suggests that (non-clickable) links will pass CI checks as long as they're followed by whitespace: #951 |
Test complete. |
TEST PR ONLY
This adds three links, one using the
{security-guide}
attribute, one using a hard-coded URL, and one using a hard-coded URL preceded by "link:". Let's see if the link checker complains about these.Here's how the output renders:
I'm trying to understand the following link checking error from this build:
Preview: https://ingest-docs_bk_947.docs-preview.app.elstc.co/guide/en/fleet/master/fleet-troubleshooting.html