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

Ability to evaluate "external" links that are really just internal links #90

Open
kodster28 opened this issue Feb 6, 2025 · 2 comments

Comments

@kodster28
Copy link

Is your feature request related to a problem?

Limitation when people specify a link externally (https://developers.cloudflare.com/workers/) that should really be evaluated (and flagged) as if they're internal links (/workers/).

This situation skips evaluation, as demonstrated in this test PR || CI run

Describe the solution you'd like

I'd love it if you were able to specify a host or at least a pattern to ignore so that these links would be evaluated as internal.

That way, we could accept the links and know that they were valid and then fix in the background gradually.

Describe alternatives you've considered

We have linting around this in PRs, but it does add friction for contributors.
https://github.com/cloudflare/cloudflare-docs/pull/19799/files#r1945066002

As long we can evaluate these links successfully, we'd love to just not even worry about this in reviews and fix these on a cadence.

Additional Context

No response

@kodster28
Copy link
Author

Also, just thanks so much for having made this.

Sooooo glad we didn't have to maintain our previous link checking (manual crawling / comparing outputs). Not fun!

@HiDeoo
Copy link
Owner

HiDeoo commented Feb 11, 2025

👋 Thanks for the kind words.

Interesting use case. I don't think it's something I've think about before.

My first question (and not trying to ditch the feature request, just my normal train of thought) is, if the link should be /workers/, shouldn't this be handled by another remark plugin running before the validation transforming https://developers.cloudflare.com/workers/ into /workers/, and maybe enabled by default and disabled (using an environment variable) during the linting for this run on a specific cadence?

I'll think about the request anyway, if it would be a good addition to the plugin and more specifically which form it should take.

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

2 participants