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

Find and fix broken/dead links #54

Open
neomatrix369 opened this issue Nov 6, 2019 · 4 comments
Open

Find and fix broken/dead links #54

neomatrix369 opened this issue Nov 6, 2019 · 4 comments
Labels
good first issue Good for newcomers hacktoberfest Part of the Hacktoberfest 2020 (https://hacktoberfest.digitalocean.com)

Comments

@neomatrix369
Copy link
Owner

neomatrix369 commented Nov 6, 2019

As see from #53 we can have broken/dead links, links that once worked can be unavailable for reasons outside the control of this project/repo!

Hence I have decided to manually scan (for now) the repo from time to time for such links and fix them - if there is one. Here are the steps to take:

New broken/dead links

$ ls **/*.md | xargs -n 1 markdown-link-check --quiet

### This recursively finds all markdown files in the repo, 
### scans them and only reports those files which have 
### broken/dead links in them. 
  • try to fix the broken/dead links by hand
  • we are only looking for HTTP response code of 404, any other response codes can be ignored
  • if a fix cannot be found, best mark the link with a '[deadlink]' marker
  • in certain cases it's a good idea to leave the old link with the '[deadlink]' marker next to it even though we have found a new working one

Existing broken/dead links across the repo

Existing dead/broken links are marked with the '[deadlink]' marker.

As part of this issue, fixing these links is also helpful - although if they are left in there it's cause their fix wasn't immediately available or found on searching on the relevant sources.

Eventually, we can automate the task of finding such links via a GitHub action during GitHub events like commit, push or pull request creation.

@neomatrix369 neomatrix369 added the good first issue Good for newcomers label Nov 6, 2019
@neomatrix369 neomatrix369 added this to To do in awesome-ai-ml-dl via automation Nov 6, 2019
@neomatrix369 neomatrix369 added the hacktoberfest Part of the Hacktoberfest 2020 (https://hacktoberfest.digitalocean.com) label Sep 25, 2020
@premalrupnur
Copy link

premalrupnur commented Oct 8, 2020

I would like to work on this,may I take this issue????

@neomatrix369
Copy link
Owner Author

I would like to work on this,may I take this issue????

Great sure you can work on this issue, this is a recurring/open issue so best you use the instructions/tips placed in this issue to generate the deadlines and fix them and create a new PR for it - how does that sound?

@premalrupnur
Copy link

premalrupnur commented Oct 8, 2020

Ya will do that!!
But by fixing the links do you mean deleting those ??

@neomatrix369
Copy link
Owner Author

Ya will do that!!
But by fixing the links do you mean deleting those ??

Please read the description of the issue, it outlines it all. Step by step and systematically, if you don't follow it please ask me then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers hacktoberfest Part of the Hacktoberfest 2020 (https://hacktoberfest.digitalocean.com)
Projects
Development

No branches or pull requests

2 participants