NLESC-JCER / cpp2wasm

Guide to make C++ available as a web application
https://nlesc-jcer.github.io/cpp2wasm/
Apache License 2.0
22 stars 6 forks source link

Markdown link checker #56

Closed jspaaks closed 4 years ago

jspaaks commented 4 years ago

Added a GitHub action to check links within all markdown files, both outgoing links and internal links.

For the review, I have disabled the schedule part, we should enable this once this PR is approved.

At this time, there is just one broken link (celery), but that seems to be due to the site being down --the link is correct.

Refs #44

jspaaks commented 4 years ago

I corrected the celery link see 6440785, but now Zenodo seems to be unresponsive.

My experience with the broken link checker on the guide (https://github.com/NLeSC/guide/blob/632ca33de9bcc338a5c4ed3a7b3ea60081c0b968/.travis.yml#L10-L13) is that there is always going to be links that are (temporarily) down. Perhaps we can improve the GitHub Action someday by adding either a threshold like I did in the link, or retaining history-of-checking state for each link, and only return red if you checked it a couple times and all came back broken.

sverhoeven commented 4 years ago

Yeah,

I corrected the celery link see 6440785, but now Zenodo seems to be unresponsive.

My experience with the broken link checker on the guide (https://github.com/NLeSC/guide/blob/632ca33de9bcc338a5c4ed3a7b3ea60081c0b968/.travis.yml#L10-L13) is that there is always going to be links that are (temporarily) down. Perhaps we can improve the GitHub Action someday by adding either a threshold like I did in the link, or retaining history-of-checking state for each link, and only return red if you checked it a couple times and all came back broken.

Agree, but site has been down for 9 days already so using alternative url made sense in this case.