se-edu / guides

Style guides and tutorials for SE student projects
MIT License
7 stars 26 forks source link

(Bug) Broken links found in some pages #5

Closed yhtMinceraft1010X closed 1 year ago

yhtMinceraft1010X commented 1 year ago

Description

I ran a scan of all the pages under https://se-education.org/guides/ using Linkinator with the following command:

npx linkinator http://se-education.org/guides/ --recurse --format JSON 

5 broken links were found below:

{
  "Date Generated": "24/01/2023 20:12",
  "URL List": [
    {
      "url": "https://mvnrepository.com/artifact/com.joestelmach/natty/0.6",
      "status": 403,
      "state": "BROKEN",
      "parent": "http://se-education.org/guides/tutorials/gradle.html"
    },
    {
      "url": "http://se-education.org/guides/conventions/index.page-vue-render.js",
      "status": 404,
      "state": "BROKEN",
      "parent": "http://se-education.org/guides/conventions/java"
    },
    {
      "url": "https://github.com/MarkBind/markbind/edit/master/.github/ISSUE_TEMPLATE/bug-report.md",
      "status": 404,
      "state": "BROKEN",
      "parent": "http://se-education.org/guides/conventions/github.html"
    },
    {
      "url": "https://mdn.beonex.com/en/CSS/Writing_Efficient_CSS.html",
      "status": 404,
      "state": "BROKEN",
      "parent": "http://se-education.org/guides/conventions/css.html"
    },
    {
      "url": "http://se.inf.ethz.ch/old/teaching/ss2007/251-0290-00/project/CSharpCodingStandards.pdf",
      "status": 404,
      "state": "BROKEN",
      "parent": "http://se-education.org/guides/conventions/csharp.html"
    }
  ]
}

Solution

The general steps to follow when solving this are as follows:

1) Verify if there are any false positives (Based on what I've looked at thus far, I think only the first finding is a false positive) 1) Find the context of the broken link (what is the original intention of the link etc) 1) Using the context, find a suitable substitute link

damithc commented 1 year ago

Thanks for the bug report. The second one is inserted by MarkBind. The first one is a false positive. I've removed the rest.