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.

Sign up for GitHub

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

Jump to bottom

docs: detect and fix broken links #416

Merged

nzakas merged 11 commits into main from detect-broken-links

Mar 1, 2023

Contributor

snitin315 commented Feb 11, 2023

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request?

Validate internal links on CI.

What changes did you make? (Give an overview)

Same as eslint/eslint#16837

Related Issues

eslint/eslint#16833

Is there anything you'd like reviewers to focus on?

No

eslint-github-bot bot added the triage label

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for new-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/new-eslint/deploys/63f817454bcea200089d54c7
😎 Deploy Preview	https://deploy-preview-416--new-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

eslint-github-bot bot added the documentation label

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for es-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/es-eslint/deploys/63f81745be4f36000811c84a
😎 Deploy Preview	https://deploy-preview-416--es-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for ja-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/ja-eslint/deploys/63f8174538fee000075880f1
😎 Deploy Preview	https://deploy-preview-416--ja-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for zh-hans-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/zh-hans-eslint/deploys/63f817457ea48a0008cb9621
😎 Deploy Preview	https://deploy-preview-416--zh-hans-eslint.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for hi-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/hi-eslint/deploys/63f81745a7d6bb0008e689c1
😎 Deploy Preview	https://deploy-preview-416--hi-eslint.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for fr-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/fr-eslint/deploys/63f81745c9c9cb000885e629
😎 Deploy Preview	https://deploy-preview-416--fr-eslint.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for de-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/de-eslint/deploys/63f81745be4f36000811c850
😎 Deploy Preview	https://deploy-preview-416--de-eslint.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Feb 11, 2023 •

edited

✅ Deploy Preview for pt-br-eslint ready!

Name	Link
🔨 Latest commit	`662daa6`
🔍 Latest deploy log	https://app.netlify.com/sites/pt-br-eslint/deploys/63f8174525064f0008421e6a
😎 Deploy Preview	https://deploy-preview-416--pt-br-eslint.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

amareshsm added accepted and removed triage labels

harish-sethuraman previously approved these changes

View reviewed changes

Member

harish-sethuraman left a comment

LGTM, Will wait for one more review. Checked the pages where changes were made ✅ .

amareshsm reviewed

View reviewed changes

Member

amareshsm left a comment

When I tried npm run lint:links it is taking 3-4mins to complete. Is this fine?

Contributor Author

snitin315 commented Feb 13, 2023

Yes, it's taking time as it is checking almost 1800 links. I don't know if there is a way to speed up this.

amareshsm reviewed

View reviewed changes

Member

amareshsm left a comment

can we do this linting to staged files?

Member

nzakas commented Feb 13, 2023

Because this takes so long, I don't think we should run this as part of regular linting. Right now, npm run lint will run this and I think that could be confusing and frustrating if people don't know what's happening. We can definitely run this check in CI, but otherwise, I think we should just check precommit files locally and let people choose to run the link check only if they want.

Contributor Author

snitin315 commented Feb 15, 2023

Makes sense. I will update the script to run on CI only.

Member

nzakas commented Feb 15, 2023

I think we should match this up: eslint/eslint#16837 (comment)

snitin315 force-pushed the detect-broken-links branch from 33e1064 to 28ca6c5 Compare

February 18, 2023 12:36

snitin315 commented

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

mdjermanovic reviewed

View reviewed changes

tools/validate-links.js Outdated Show resolved Hide resolved

snitin315 dismissed harish-sethuraman’s stale review

February 21, 2023 05:07

More changes

snitin315 and others added 7 commits

February 24, 2023 01:42


          docs: detect and fix broken links

3e2e2af


          ci: fix


          ci: fix


          chore: use custom script

db866c6


          chore: fix syntax error

b170407


          chore: fix script

b21c63c


          chore: remove unwanted changes

7ad9ee5

snitin315 added 3 commits

February 24, 2023 01:42


          ci: test script on windows

3a5ea06


          ci: test script on windows

a5f6614


          ci: use ubuntu runner

2fb08d1

snitin315 force-pushed the detect-broken-links branch from d5602f8 to 2fb08d1 Compare

February 24, 2023 01:47


          ci: uncomment steps

662daa6

snitin315 requested a review from mdjermanovic

February 24, 2023 01:51

mdjermanovic approved these changes

View reviewed changes

Member

mdjermanovic left a comment

LGTM, thanks! Leaving this open for others to verify.

snitin315 requested a review from harish-sethuraman

February 27, 2023 02:52

nzakas approved these changes

View reviewed changes

Member

nzakas left a comment

LGTM. Nice work!

nzakas merged commit 53721e9 into main

nzakas deleted the detect-broken-links branch

March 1, 2023 21:47

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment