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

Broken image link is not being reported consistently #1

Open
amimas opened this issue Jul 5, 2019 · 1 comment
Open

Broken image link is not being reported consistently #1

amimas opened this issue Jul 5, 2019 · 1 comment

Comments

@amimas
Copy link

amimas commented Jul 5, 2019

I'm using this rule to validate broken links in my documentation generated by Docusaurus. The rule is behaving inconsistently.

On my local machine (macos), when I run this rule it does not report any errors. But, when this rule runs on my CI pipeline, it's able to report a broken image link.

The text where it's reporting the error contains a link like this:

    ![Resource role permission in felix web console](assets/WEBCONSOLE.png)

The actual image file is saved with all lower case name (i.e. webconsole.png). But, not sure why the rule is not reporting this as an error on my mac

@amimas
Copy link
Author

amimas commented Jul 9, 2019

I've been doing some more debugging. Although it's not conclusive yet, I believe the issue is platform related. For example, the file system on mac, I believe, is not case-sensitive while it is case sensitive in linux/unix.

That could explain why on my mac when I execute the test, this linter rule didn't report any error and when the local dev server from Docusaurus runs, the image still appears on the website. But, my CI pipeline runs on a CentOS based machine where the linter is able to report the broken link (due to file name's case sensitivity) and when the site is deployed in AWS S3, the image does not appear on the site because in AWS S3 bucket the file names are case-sensitive.

Only concern right now is that I can't seem to reproduce the issue. I tried running the linter rule on a centos based docker image running on my mac but that didn't help. Might need a base linux environment to test it out.

It'd be good if this rule can validate case-sensitivity of the file/path name.

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